Merge pull request #34 from crgwbr/crweber/improve-is-empty

Improve isEmpty

Author: onebytegone

src/utils/is-empty.ts

@@ -2,6 +2,32 @@ import { isArray } from './is-array';
 import { isString } from './is-string';
 import { isArguments } from './is-arguments';
 import { isUndefined } from './is-undefined';
+import { isNull } from './is-null';
+import { isBoolean } from './is-boolean';
+import { isNumber } from './is-number';
+import { isSet } from './is-set';
+import { isObject } from './is-object';
+
+
+interface IEmptyArguments extends IArguments {
+   length: 0;
+}
+
+interface IEmptyObj {
+   [s: string]: never;
+}
+
+type IEmptyTypes = (
+   null |
+   undefined |
+   boolean |
+   number |
+   never[] |
+   '' |
+   IEmptyArguments |
+   Set<never> |
+   IEmptyObj
+);
 
 /**
  * Checks if `o` is an empty object. An object is "empty" if it:
@@ -12,16 +38,15 @@ import { isUndefined } from './is-undefined';
  *
  * @returns `true` if `o` is empty
  */
-export function isEmpty(o: unknown): boolean {
-   if (o === null || isUndefined(o)) {
+export function isEmpty(o: unknown): o is IEmptyTypes {
+   if (isNull(o) || isUndefined(o) || isBoolean(o) || isNumber(o)) {
       return true;
    }
    if (isArray(o) || isString(o) || isArguments(o)) {
       return o.length === 0;
    }
-   // Non-object arguments passed into Object.keys are coerced into objects (the only
-   // exception being undefined or null, which is handled above). Therefore, it's ok to
-   // assume the input is an object because it will be once passed through. See also:
-   // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/keys#using_object.keys_on_primitives
-   return Object.keys(o as object).length === 0;
+   if (isSet(o)) {
+      return o.size === 0;
+   }
+   return isObject(o) && Object.keys(o).length === 0;
 }

tests/utils/is-empty.test.ts

@@ -6,6 +6,7 @@ describe('isEmpty', () => {
 
    it('correctly classifies empty things', () => {
       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);
@@ -41,6 +42,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);
    });
 
 });