Merge pull request #10 from angular-package/3.3.x

3.3.2

Author: angularpackage

packages/type/package.json

@@ -13,13 +13,30 @@
     "registry": "https://registry.npmjs.org"
   },
   "keywords": [
-    "angular-package",
-    "@angular-package",
-    "@angular-package/type",
-    "guards",
+    "array",
+    "bigint",
+    "boolean",
+    "check",
+    "defined",
+    "determine",
+    "function",
+    "guard",
+    "instance",
+    "key",
+    "propertyKey",
+    "number",
+    "object",
+    "primitive",
+    "string",
+    "symbol",
+    "undefined",
     "type",
     "types",
-    "type guards"
+    "type guards",
+    "typescript",
+    "angular-package",
+    "@angular-package",
+    "@angular-package/type"
   ],
   "repository": {
     "type": "git",

packages/type/src/are/lib/are-string.func.ts

@@ -1,9 +1,7 @@
 import { check } from './check-args.func';
-
 /**
- * Checks if all of any arguments are a `'string'` type.
- * @param args Any arguments to check if they're all a `'string'` type.
- * @returns boolean.
- * @example https://www.typescriptlang.org/play?jsx=0#code/C4TwDgpgBAkgzgZWAJwJYDsDmUC8UAUAbgIYA2ArhAFxTHogCUuAfFCRdKnFHChpgG4AUKEhQACmgC2qYKkIRueAOQAjVJgzBlUAD5Q1Ae0OkIdHfuXpyU1RGQWDcELZOPlvNFnfl0AEwgAMwwIP2VhAGNDdF4oLiQvTBp4BP5cAnZKGjpGGkzObk80nFZ8uJjgOgiIQ0CoVKw9fVEaurKcDqc+b0jo2IiACwgIgGt0-BaaSVQZOQU4ABooADpV4mRMOGz6BhpVY1M6FigAbyEoKFNgKGRFclJrvBRKYQurqCkIYAHDP2TEbqCc48ADuskGBBaTDOFwuEWIcGgHkByhon2+v3S8UBAigqluxBGr1hAUCxHuwDRXx+fixAMSuPxZiJwIAvsDAoZkAQohVaBsoLV+ZtocCLrc4BT0uiafh1pgGMSLqg6vgJVKOngyaREaLYbCmYSlVB2RdTTcvuRkOgLZKHsJWb0+esIA1sHh8KtlvKtrQdnsDmYbSUoINhiN8MjEsoll6fYqhEIAPRJqAANXWqGIqlMcCEvNiCAAKgAlGAAOQA4gB9NMAQQAMgBVACi6WUDa5ECkcTAkqkAH5wvm+tdy02ALIAIRbJdrjdb6QATAB2J2xKcAeU3DZbdfL8+bba1ZER6+uTfLABEWwAxCstq+H1vVosAdU36V8pJCfmE70vG973LR9nxbYQRxiEwIGWUhDEwOVbjdfBALvB8n3rI8lmLMsqzApZx2nWd8KgLcdz3A9MNbBhFSgFMoG1RFILgaDYPgxDXUBfAcIrGsqJbbDS14sCaNxejnggZjWLghCXWQni8P4wTcL4hcBNI7dd33ETaPoxjJILaT2LkriFNUrCNPI7SlPqITFLU0S6NTfSgA
+ * Checks if any of all the values are a `string`.
+ * @param value Any arguments to check if they're all a `'string`.
+ * @returns A `boolean` indicating whether or not all the `values` are an `Array`.
  */
-export const areString = (...args: any): boolean => check('string', ...args);
+export const areString = (...value: any): boolean => check('string', ...value);

packages/type/src/are/test/are-string.spec.ts

@@ -1,33 +1,21 @@
 
 import { areString } from '../lib/are-string.func';
 
-describe('areString()', () => {
+describe(areString.name, () => {
 
   beforeEach(async () => {});
 
   beforeEach(() => {});
 
-  it('is DEFINED', () => {
-    expect(areString).toBeDefined();
-  });
+  it('is DEFINED', () => expect(areString).toBeDefined());
 
-  it(`string to be TRUE`, () => {
-    expect(areString('one', 'two', 'three')).toBeTruthy();
-  });
+  it(`string to be TRUE`, () => expect(areString('one', 'two', 'three')).toBeTruthy());
 
-  it(`number to be FALSE`, () => {
-    expect(areString(1, 2, 3)).toBeFalsy();
-  });
+  it(`number to be FALSE`, () => expect(areString(1, 2, 3)).toBeFalsy());
 
-  it(`boolean to be FALSE`, () => {
-    expect(areString(true, false, false)).toBeFalsy();
-  });
+  it(`boolean to be FALSE`, () => expect(areString(true, false, false)).toBeFalsy());
 
-  it(`string with number to be FALSE`, () => {
-    expect(areString('one', 'two', 'three', 3)).toBeFalse();
-  });
+  it(`string with number to be FALSE`, () => expect(areString('one', 'two', 'three', 3)).toBeFalse());
 
-  it(`string with array to be FALSE`, () => {
-    expect(areString('one', 'two', 'three', ['3'])).toBeFalse();
-  });
+  it(`string with array to be FALSE`, () => expect(areString('one', 'two', 'three', ['3'])).toBeFalse());
 });

packages/type/src/are/type/are-string.type.ts

@@ -1 +1 @@
-export type AreString = (...params: any) => boolean;
+export type AreString = (...value: any) => boolean;

packages/type/src/guard/interface/guard-interface.ts

@@ -1,7 +1,4 @@
 import { GuardIs } from './guard-is.interface';
-import { GuardAre } from './guard-are.interface';
-
 export interface Guard {
   is: GuardIs;
-  // are: GuardAre;
 }

packages/type/src/guard/lib/guard-is.object.ts

@@ -24,8 +24,8 @@ export const guardIs: GuardIs = {
   function: guardFunction,
   instance: guardInstance,
   key: guardKey,
-  number: guardNumber,
   null: guardNull,
+  number: guardNumber,
   object: guardObject,
   objectKey: guardObjectKey,
   primitive: guardPrimitive,

packages/type/src/guard/lib/guard-primitive.func.ts

@@ -13,5 +13,5 @@ import { ResultCallback } from '../../type/result-callback.type';
  * @returns A `boolean` indicating whether or not the `value` is the `Primitive` from the `type`.
  */
 export const guardPrimitive: GuardPrimitive =
-  <Type extends Primitive>(value: Type, type: Primitives, callback?: ResultCallback): value is Type => 
+  <Type extends Primitive>(value: Type, type: Primitives, callback?: ResultCallback): value is Type =>
     isPrimitive<Type>(value, type, callback);

packages/type/src/guard/test/guard-array.spec.ts

@@ -1,10 +1,6 @@
 // Function.
 import { guardArray } from '../lib/guard-array.func';
 // Variables.
-import { BIGINT, BIGINT_INSTANCE } from '../../is/test/variables/big-int.const';
-import { Class } from '../../is/test/variables/class.const';
-import { Func } from '../../type/func.type';
-import { ObjectOne, ObjectTwo, OBJECT_ONE, OBJECT_TWO } from '../../is/test/variables/object.const';
 import {
   ARRAY_BIGINT,
   ARRAY_BOOLEAN,
@@ -18,60 +14,31 @@ import {
   ARRAY_SYMBOL_NUMBER,
   ARRAY_SYMBOL_STRING,
   ARRAY_UNDEFINED
-} from '../../is/test/variables/array.const';
-import { FALSE, TRUE, FALSE_INSTANCE, TRUE_INSTANCE } from '../../is/test/variables/boolean.const';
-import { FUNCTION } from '../../is/test/variables/function.const';
-import { NUMBER, NUMBER_INSTANCE, NUMBER_NEW_INSTANCE } from '../../is/test/variables/number.const';
-import { STRING, STRING_INSTANCE } from '../../is/test/variables/string.const';
-import { SYMBOL_NUMBER, SYMBOL_STRING } from '../../is/test/variables/symbol.const';
-import { UNDEFINED } from '../../is/test/variables/undefined.const';
-import { notDefined } from '../../is/test/variables/not-defined.const';
+} from './variables/array.const';
+import { Class } from './variables/class.const';
+import { Func } from '../../type/func.type';
+import { ObjectOne, ObjectTwo } from './variables/object.const';
 
-describe('guardArray', () => {
+describe(guardArray.name, () => {
   // TRUE
   it('is DEFINED', () => {
     expect(guardArray).toBeDefined();
   });
 
   it('Array<bigint>', () => expect(guardArray<bigint>(ARRAY_BIGINT)).toBeTruthy());
-  it('Array<boolean>', () => expect(guardArray<boolean>(ARRAY_BOOLEAN)).toBeTruthy());
+  it('Array<boolean>', () => expect(guardArray<boolean | Boolean>(ARRAY_BOOLEAN)).toBeTruthy());
   it('Array<Class>', () => expect(guardArray<Class>(ARRAY_CLASS)).toBeTruthy());
   it('Array<Func>', () => expect(guardArray<Func>(ARRAY_FUNCTION)).toBeTruthy());
   it('Array<null>', () => expect(guardArray<null>(ARRAY_NULL)).toBeTruthy());
-  it('Array<number>', () => expect(guardArray<number>(ARRAY_NUMBER)).toBeTruthy());
+  it('Array<number>', () => expect(guardArray<number | Number>(ARRAY_NUMBER)).toBeTruthy());
   it('Array<ObjectOne> Array<ObjectTwo>', () => {
     expect(guardArray<ObjectOne>(ARRAY_OBJECT_ONE)).toBeTruthy();
     expect(guardArray<ObjectTwo>(ARRAY_OBJECT_TWO)).toBeTruthy();
   });
-  it('Array<string>', () => expect(guardArray<string>(ARRAY_STRING)).toBeTruthy());
+  it('Array<string>', () => expect(guardArray<string | String>(ARRAY_STRING)).toBeTruthy());
   it('Array<symbol>', () => {
     expect(guardArray<symbol>(ARRAY_SYMBOL_STRING)).toBeTruthy();
     expect(guardArray<symbol>(ARRAY_SYMBOL_NUMBER)).toBeTruthy();
   });
   it('Array<undefined>', () => expect(guardArray<undefined>(ARRAY_UNDEFINED)).toBeTruthy());
-
-  // FALSE
-  it(`'bigint'`, () => {
-    expect(guardArray(BIGINT)).toBeFalsy();
-    expect(guardArray(BIGINT_INSTANCE)).toBeFalsy();
-  });
-  it(`'boolean' | Boolean`, () => {
-    expect(guardArray(FALSE)).toBeFalsy();
-    expect(guardArray(TRUE)).toBeFalsy();
-    expect(guardArray(FALSE_INSTANCE)).toBeFalsy();
-    expect(guardArray(TRUE_INSTANCE)).toBeFalsy();
-  });
-  it(`'number' | Number`, () => {
-    expect(guardArray(NUMBER)).toBeFalsy();
-    expect(guardArray(NUMBER_INSTANCE)).toBeFalsy();
-    expect(guardArray(NUMBER_NEW_INSTANCE)).toBeFalsy();
-  });
-  it(`'string' | String`, () => {
-    expect(guardArray<string>(STRING)).toBeFalsy();
-    expect(guardArray<string>(STRING_INSTANCE)).toBeFalsy();
-  });
-  it(`'undefined'`, () => {
-    expect(guardArray<undefined>(notDefined)).toBeFalse();
-    expect(guardArray<undefined>(UNDEFINED)).toBeFalse();
-  });
 });

packages/type/src/guard/test/guard-bigint.spec.ts

@@ -1,86 +1,30 @@
 // Function.
 import { guardBigInt } from '../lib/guard-big-int.func';
 // Variables.
-import { BIGINT, BIGINT_EXPECTATION, BIGINT_INSTANCE } from '../../is/test/variables/big-int.const';
-// import { Class, CLASS } from '../../is/test/variables/class.const';
-// import { FUNCTION } from '../../is/test/variables/function.const';
-import { NULL } from '../../is/test/variables/null.const';
-import { NUMBER, NUMBER_INSTANCE, NUMBER_NEW_INSTANCE } from '../../is/test/variables/number.const';
-// import { OBJECT_ONE, OBJECT_TWO, OBJECT_ONE_NEW, OBJECT_TWO_NEW } from '../../is/test/variables/object.const';
-import { STRING, STRING_INSTANCE, STRING_NEW_INSTANCE } from '../../is/test/variables/string.const';
-// import { SYMBOL_NUMBER, SYMBOL_STRING } from '../../is/test/variables/symbol.const';
-import { TRUE, FALSE, FALSE_EXPECTATION, TRUE_EXPECTATION, TRUE_INSTANCE, FALSE_INSTANCE } from '../../is/test/variables/boolean.const';
-import { UNDEFINED } from '../../is/test/variables/undefined.const';
+import { BIGINT, BIGINT_EXPECTATION, BIGINT_INSTANCE } from './variables/big-int.const';
+import { TRUE } from './variables/boolean.const';
 
-describe(`guardBigInt`, () => {
+describe(guardBigInt.name, () => {
   // Defined.
   it('is DEFINED', () => expect(guardBigInt).toBeDefined());
 
   // Checks ...
   describe(`checks`, () => {
     it('callback', () => {
-      guardBigInt(STRING, (result: boolean) => {
-        expect(result).toBe(FALSE);
+      guardBigInt(BIGINT, (result: boolean, value: bigint) => {
+        expect(result).toBe(TRUE);
+        expect(value).toEqual(BIGINT);
         return result;
       });
     });
 
-    // ... arrays.
-    describe(`array`, () => {
-      // it(`${FUNCTION}`, () => expect(guardBigInt(FUNCTION, 'function')).toBe(FALSE));
-      // it(`${Class}`, () => expect(guardBigInt(Class, 'function')).toBe(FALSE));
-    });
-    // ... function.
-    describe(`function`, () => {
-      // it(`FUNCTION`, () => expect(guardBigInt(FUNCTION)).toBe(FALSE));
-      // it(`Class`, () => expect(guardBigInt(Class)).toBe(FALSE));
-    });
-    // ... objects.
-    describe('object', () => {
-      // it(`CLASS`, () => expect(guardBigInt(CLASS)).toBe(FALSE));
-      // it(`OBJECT_ONE`, () => expect(guardBigInt(OBJECT_ONE)).toBe(FALSE));
-      // it(`OBJECT_TWO`, () => expect(guardBigInt(OBJECT_TWO)).toBe(FALSE));
-      // it(`new Object(OBJECT_ONE_NEW})`, () => expect(guardBigInt(OBJECT_ONE_NEW)).toBe(FALSE));
-      // it(`new Object(OBJECT_TWO_NEW})`, () => expect(guardBigInt(OBJECT_TWO_NEW)).toBe(FALSE));
-    });
     // ... primitives.
     describe(`primitive`, () => {
       // bigint
       describe(`bigint`, () => {
         it(`${BIGINT}`, () => expect(guardBigInt(BIGINT)).toBe(TRUE));
         it(`${BIGINT_EXPECTATION}`, () => expect(guardBigInt(BIGINT_INSTANCE)).toBe(TRUE));
       });
-
-      // boolean
-      describe(`boolean`, () => {
-        it(`${TRUE}`, () => expect(guardBigInt(TRUE)).toBe(FALSE));
-        it(`${FALSE}`, () => expect(guardBigInt(FALSE)).toBe(FALSE));
-        it(`${FALSE_EXPECTATION}`, () => expect(guardBigInt(TRUE_INSTANCE)).toBe(FALSE));
-        it(`${TRUE_EXPECTATION}`, () => expect(guardBigInt(FALSE_INSTANCE)).toBe(FALSE));
-      });
-
-      // null
-      it(`${NULL}`, () => expect(guardBigInt(NULL)).toBe(FALSE));
-
-      // number
-      describe(`number`, () => {
-        it(`${NUMBER}`, () => expect(guardBigInt(NUMBER)).toBe(FALSE));
-        it(`Number(${NUMBER})`, () => expect(guardBigInt(NUMBER_INSTANCE)).toBe(FALSE));
-        it(`new Number(${NUMBER})`, () => expect(guardBigInt(NUMBER_NEW_INSTANCE)).toBe(FALSE));
-      });
-      // string
-      describe(`string`, () => {
-        it(`${STRING}`, () => expect(guardBigInt(STRING)).toBe(FALSE));
-        it(`String(${STRING})`, () => expect(guardBigInt(STRING_INSTANCE)).toBe(FALSE));
-        it(`new String(${STRING})`, () => expect(guardBigInt(STRING_NEW_INSTANCE)).toBe(FALSE));
-      });
-      // symbol
-      describe(`symbol`, () => {
-        // it(`Symbol(${NUMBER})`, () => expect(guardBigInt(SYMBOL_NUMBER)).toBe(FALSE));
-        // it(`Symbol(${STRING})`, () => expect(guardBigInt(SYMBOL_STRING)).toBe(FALSE));
-      });
-      // undefined
-      it(`${UNDEFINED}`, () => expect(guardBigInt(UNDEFINED)).toBe(FALSE));
     });
   });
 });

packages/type/src/guard/test/guard-boolan.spec.ts

@@ -0,0 +1,29 @@
+// Function.
+import { guardBoolean } from '../lib/guard-boolean.func';
+// Variables.
+import { FALSE_EXPECTATION, TRUE, TRUE_EXPECTATION, FALSE } from './variables/boolean.const';
+
+describe(guardBoolean.name, () => {
+  // Defined.
+  it('is DEFINED', () => expect(guardBoolean).toBeDefined());
+
+  // Checks ...
+  describe(`checks`, () => {
+    it('callback', () => {
+      guardBoolean(TRUE, (result: boolean, value: boolean) => {
+        expect(result).toBe(TRUE);
+        expect(value).toEqual(TRUE);
+        return result;
+      });
+    });
+
+    // ... primitives.
+    describe(`primitive`, () => {
+      // boolean
+      describe(`boolean`, () => {
+        it(`${FALSE_EXPECTATION}`, () => expect(guardBoolean(FALSE)).toBe(TRUE));
+        it(`${TRUE_EXPECTATION}`, () => expect(guardBoolean(TRUE)).toBe(TRUE));
+      });
+    });
+  });
+});