feat: Make isEmpty work for Sets (silvermine#31)

src/index.ts

@@ -20,6 +20,7 @@ export * from './utils/is-number';
 export * from './utils/is-object';
 export * from './utils/is-promise';
 export * from './utils/is-promise-like';
+export * from './utils/is-set';
 export * from './utils/is-string';
 export * from './utils/is-undefined';
 

src/utils/is-empty.ts

@@ -2,6 +2,7 @@ import { isArray } from './is-array';
 import { isString } from './is-string';
 import { isArguments } from './is-arguments';
 import { isUndefined } from './is-undefined';
+import { isSet } from './is-set';
 
 /**
  * Checks if `o` is an empty object. An object is "empty" if it:
@@ -19,5 +20,8 @@ export function isEmpty(o: any): boolean {
    if (isArray(o) || isString(o) || isArguments(o)) {
       return o.length === 0;
    }
+   if (isSet(o)) {
+      return o.size === 0;
+   }
    return Object.keys(o).length === 0;
 }

src/utils/is-set.ts

@@ -0,0 +1,8 @@
+/**
+ * Type guard for `Set`s.
+ *
+ * @returns `true` if `o` is a `Set`, regardless of the types that it contains
+ */
+export function isSet(o: unknown): o is Set<unknown> {
+   return o instanceof Set;
+}

tests/utils/is-empty.test.ts

@@ -8,6 +8,7 @@ describe('isEmpty', () => {
       let o;
 
       expect(t.isEmpty([])).to.strictlyEqual(true);
+      expect(t.isEmpty(new Set([]))).to.strictlyEqual(true);
       // eslint-disable-next-line
       expect(t.isEmpty(new Array())).to.strictlyEqual(true);
       expect(t.isEmpty({})).to.strictlyEqual(true);
@@ -42,6 +43,7 @@ describe('isEmpty', () => {
       expect(t.isEmpty({ length: 0 })).to.strictlyEqual(false);
       expect(t.isEmpty([ 1 ])).to.strictlyEqual(false);
       expect(t.isEmpty(new Array(10))).to.strictlyEqual(false);
+      expect(t.isEmpty(new Set([ 1 ]))).to.strictlyEqual(false);
    });
 
 });

tests/utils/is-set.test.ts

@@ -0,0 +1,30 @@
+import { expect } from 'chai';
+import * as t from '../../src/index';
+
+
+describe('isSet', () => {
+
+   it('correctly classifies sets', () => {
+      expect(t.isSet(new Set([]))).to.strictlyEqual(true);
+      expect(t.isSet(new Set([ 'a', 'b', 'c' ]))).to.strictlyEqual(true);
+      expect(t.isSet(new Set([ 4 ]))).to.strictlyEqual(true);
+      expect(t.isSet(new Set([ 'a', 'b', 'c', 4 ]))).to.strictlyEqual(true);
+      // eslint-disable-next-line
+      expect(t.isSet(new Set())).to.strictlyEqual(true);
+   });
+
+   it('correctly classifies non-sets', () => {
+      expect(t.isSet([])).to.strictlyEqual(false);
+      expect(t.isSet({})).to.strictlyEqual(false);
+      expect(t.isSet(4)).to.strictlyEqual(false);
+      expect(t.isSet('')).to.strictlyEqual(false);
+      expect(t.isSet('a')).to.strictlyEqual(false);
+      expect(t.isSet(true)).to.strictlyEqual(false);
+      expect(t.isSet(undefined)).to.strictlyEqual(false);
+      expect(t.isSet(null)).to.strictlyEqual(false);
+      expect(t.isSet({ length: 0 })).to.strictlyEqual(false);
+      // eslint-disable-next-line no-empty-function
+      expect(t.isSet(() => {})).to.strictlyEqual(false);
+   });
+
+});