Merge pull request #16 from angular-package/4.0.x

angularpackage · web-flow · commit 5ae64dae35dc · 2021-05-23T02:20:20.000+02:00
4.0.3
diff --git a/README.md b/README.md
diff --git a/packages/type/README.md b/packages/type/README.md
diff --git a/packages/type/package-lock.json b/packages/type/package-lock.json
diff --git a/packages/type/package.json b/packages/type/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@angular-package/type",
-  "version": "4.0.2",
+  "version": "4.0.3",
   "description": "Common types, type guards and type checkers.",
   "author": "Angular Package <angular-package@wvvw.dev> (https://wvvw.dev)",
   "homepage": "https://github.com/angular-package/type#readme",
diff --git a/packages/type/src/guard/lib/guard-object-key.func.ts b/packages/type/src/guard/lib/guard-object-key.func.ts
@@ -6,10 +6,10 @@ import { ResultCallback } from '../../type/result-callback.type';
 /**
  * Guard the `value` to be an `object` of a generic `Obj` type that contains the `key`.
  * @param value A generic `Obj` type `value` that contains the `key` to guard.
- * @param key A key of `Obj` or an array key of `Obj` type as the name of the property that the `value` contains.
+ * @param key A key of `Obj` or an array of keys of `Obj` type as the name of the property that the `value` contains.
  * @param callback An optional `ResultCallback` function to handle result before returns.
  * @returns A `boolean` indicating whether or not the `value` is an `object` of a generic `Obj` containing the `key`.
  */
 export const guardObjectKey: GuardObjectKey =
-  <Obj = object>(value: Obj, key: keyof Obj | (keyof Obj)[], callback?: ResultCallback): value is Obj =>
+  <Obj>(value: Obj, key: keyof Obj | (keyof Obj)[], callback?: ResultCallback): value is Obj =>
     isObjectKey<Obj>(value, key, callback);
diff --git a/packages/type/src/guard/lib/guard-object.func.ts b/packages/type/src/guard/lib/guard-object.func.ts
@@ -9,5 +9,5 @@ import { ResultCallback } from '../../type/result-callback.type';
  * @param callback An optional `ResultCallback` function to handle result before returns.
  * @returns A `boolean` indicating whether or not the `value` is an `object` of a generic `Obj`.
  */
-export const guardObject: GuardObject = <Obj = object>(value: Obj, callback?: ResultCallback): value is Obj =>
+export const guardObject: GuardObject = <Obj>(value: Obj, callback?: ResultCallback): value is Obj =>
   isObject<Obj>(value, callback);
diff --git a/packages/type/src/guard/type/guard-object-key.type.ts b/packages/type/src/guard/type/guard-object-key.type.ts
@@ -1,4 +1,4 @@
 import { ResultCallback } from '../../type/result-callback.type';
-export type GuardObjectKey = <Obj = object>(value: Obj, key: keyof Obj | (keyof Obj)[], callback?: ResultCallback) => value is Obj;
+export type GuardObjectKey = <Obj>(value: Obj, key: keyof Obj | (keyof Obj)[], callback?: ResultCallback) => value is Obj;
 
 
diff --git a/packages/type/src/guard/type/guard-object.type.ts b/packages/type/src/guard/type/guard-object.type.ts
@@ -1,2 +1,2 @@
 import { ResultCallback } from '../../type/result-callback.type';
-export type GuardObject = <Obj = object>(value: Obj, callback?: ResultCallback) => value is Obj;
+export type GuardObject = <Obj>(value: Obj, callback?: ResultCallback) => value is Obj;
diff --git a/packages/type/src/is/lib/is-array.func.ts b/packages/type/src/is/lib/is-array.func.ts
@@ -11,7 +11,7 @@ import { ResultCallback } from '../../type/result-callback.type';
  * @callback `resultCallback`.
  * @returns A `boolean` indicating whether or not the `value` is an `Array`.
  */
-export const isArray: IsArray = <Type>(value: any, callback: ResultCallback = resultCallback): value is Array<Type> =>
+export const isArray: IsArray = <Type = any>(value: any, callback: ResultCallback = resultCallback): value is Array<Type> =>
   callback(
     typeOf(value) === 'array' &&
     Array.isArray(value) === true &&
diff --git a/packages/type/src/is/lib/is-boolean.func.ts b/packages/type/src/is/lib/is-boolean.func.ts
@@ -11,7 +11,7 @@ import { ResultCallback } from '../../type/result-callback.type';
  * @param value Any `value` to check.
  * @param callback `ResultCallback` function to handle result before returns.
  * @callback `resultCallback`.
- * @returns A `boolean` indicating whether or not the `value` is a `boolean` type or `Boolean` object.
+ * @returns A `boolean` indicating whether or not the `value` is a `boolean` type or `Boolean` instance.
  */
 export const isBoolean: IsBoolean = (value: any, callback: ResultCallback = resultCallback): value is boolean =>
   callback(typeOf(value) === 'boolean' && (isBooleanType(value) || isBooleanObject(value)), value);
diff --git a/packages/type/src/is/lib/is-class.func.ts b/packages/type/src/is/lib/is-class.func.ts
@@ -11,7 +11,7 @@ import { ResultCallback } from '../../type/result-callback.type';
  * @callback `resultCallback`.
  * @returns A `boolean` indicating whether or not the `value` is a `class`.
  */
-export const isClass: IsClass = <Class>(value: any, callback: ResultCallback = resultCallback): value is Class =>
+export const isClass: IsClass = <Class = Function>(value: any, callback: ResultCallback = resultCallback): value is Class =>
   callback(
     (
       typeOf(value) === 'function' &&
@@ -20,7 +20,6 @@ export const isClass: IsClass = <Class>(value: any, callback: ResultCallback = r
       value instanceof Object === true
     ) ?
       /class/.test(Function.prototype.toString.call(value).slice(0, 5))
-    : false,
+      : false,
     value
   );
-
diff --git a/packages/type/src/is/lib/is-function.func.ts b/packages/type/src/is/lib/is-function.func.ts
@@ -21,6 +21,6 @@ export const isFunction: IsFunction = (value: any, callback: ResultCallback = re
       value instanceof Object === true
     ) ?
       /class/.test(Function.prototype.toString.call(value).slice(0, 5)) === false
-    : false,
+      : false,
     value
   );
diff --git a/packages/type/src/is/lib/is-instance.func.ts b/packages/type/src/is/lib/is-instance.func.ts
@@ -14,16 +14,13 @@ import { ResultCallback } from '../../type/result-callback.type';
  * @callback `resultCallback`.
  * @returns  A `boolean` indicating whether or not the `value` is an `instance` of a generic `Obj`.
  */
-export const isInstance: IsInstance = <Obj>(
-    value: any,
-    className: Constructor<Obj>,
-    callback: ResultCallback = resultCallback
-  ): value is Obj =>
+export const isInstance: IsInstance =
+  <Class>(value: any, className: Constructor<Class>, callback: ResultCallback = resultCallback): value is Constructor<Class> =>
     callback(
-      isObject<Obj>(value) ?
+      isObject<Class>(value) ?
         isClass(className) ?
           value instanceof className === true
-        : false
-      : false,
+          : false
+        : false,
       value
     );
diff --git a/packages/type/src/is/lib/is-object-key-in.func.ts b/packages/type/src/is/lib/is-object-key-in.func.ts
@@ -15,18 +15,15 @@ import { ResultCallback } from '../../type/result-callback.type';
  * @callback `resultCallback`.
  * @returns A `boolean` indicating whether or not the `value` is an `object` with the keys.
  */
-export const isObjectKeyIn: IsObjectKeyIn = <Type = object>(
-  value: any,
-  key: Key | Key[],
-  callback: ResultCallback = resultCallback
-): value is Type =>
-  callback(
-    isObject<Type>(value) ?
-      isArray(key) ?
-        key.every(k => isKey(k) ? k in value : false)
-      : isKey(key) ?
-          key in value
-        : false
-    : false,
-    value
-  );
+export const isObjectKeyIn: IsObjectKeyIn =
+  <Type = object>(value: any, key: Key | Key[], callback: ResultCallback = resultCallback): value is Type =>
+    callback(
+      isObject<Type>(value) ?
+        isArray(key) ?
+          key.every(k => isKey(k) ? k in value : false)
+          : isKey(key) ?
+            key in value
+            : false
+        : false,
+      value
+    );
diff --git a/packages/type/src/is/lib/is-object-key.func.ts b/packages/type/src/is/lib/is-object-key.func.ts
@@ -15,18 +15,15 @@ import { ResultCallback } from '../../type/result-callback.type';
  * @callback `resultCallback`.
  * @returns A `boolean` indicating whether or not the `value` is an `object` with its own specified keys.
  */
-export const isObjectKey: IsObjectKey = <Type = object>(
-  value: any,
-  key: Key | Key[],
-  callback: ResultCallback = resultCallback
-): value is Type =>
-  callback(
-    isObject<Type>(value) ?
-      isArray(key) ?
-        key.every(k => isKey(k) ? ({}).hasOwnProperty.call(value, k) === true : false)
-      : isKey(key) ?
-          ({}).hasOwnProperty.call(value, key)
-        : false
-    : false,
-    value
-  );
+export const isObjectKey: IsObjectKey =
+  <Type = object>(value: any, key: Key | Key[], callback: ResultCallback = resultCallback): value is Type =>
+    callback(
+      isObject<Type>(value) ?
+        isArray(key) ?
+          key.every(k => isKey(k) ? ({}).hasOwnProperty.call(value, k) === true : false)
+          : isKey(key) ?
+            ({}).hasOwnProperty.call(value, key)
+            : false
+        : false,
+      value
+    );
diff --git a/packages/type/src/is/test/is-class.spec.ts b/packages/type/src/is/test/is-class.spec.ts
@@ -0,0 +1,93 @@
+// Function.
+import { isClass } from '../lib/is-class.func';
+// Variables.
+import { BIGINT, BIGINT_EXPECTATION, BIGINT_INSTANCE } from './variables/big-int.const';
+import { Class, CLASS } from './variables/class.const';
+import { FALSE, TRUE, FALSE_INSTANCE, TRUE_INSTANCE, FALSE_EXPECTATION, TRUE_EXPECTATION } from './variables/boolean.const';
+import { FUNCTION } from './variables/function.const';
+import { NULL } from './variables/null.const';
+import { NUMBER, NUMBER_INSTANCE, NUMBER_NEW_INSTANCE } from './variables/number.const';
+import { OBJECT_ONE, OBJECT_TWO, OBJECT_ONE_NEW, OBJECT_TWO_NEW } from './variables/object.const';
+import { STRING, STRING_INSTANCE, STRING_NEW_INSTANCE } from './variables/string.const';
+import { SYMBOL_NUMBER, SYMBOL_STRING } from './variables/symbol.const';
+import { UNDEFINED } from './variables/undefined.const';
+/**
+ * Checks
+ * ✓ typeOf() === 'function' & typeof === 'function' && instanceof Object === true && instanceof Function === true
+ */
+describe(isClass.name, () => {
+  // Defined.
+  it('is DEFINED', () => expect(isClass).toBeDefined());
+
+  // Checks ...
+  describe(`checks`, () => {
+    it('callback', () => {
+      isClass(Class, (result: boolean, value: any) => {
+        expect(result).toBe(TRUE);
+        expect(value).toEqual(Class);
+        return result;
+      });
+    });
+    // ... arrays.
+    describe(`array`, () => {
+      // it(`${FUNCTION}`, () => expect(isClass(FUNCTION, 'function')).toBe(FALSE));
+      // it(`${Class}`, () => expect(isClass(Class, 'function')).toBe(FALSE));
+    });
+    // ... function.
+    describe(`function`, () => {
+      it(`FUNCTION`, () => expect(isClass(FUNCTION)).toBe(FALSE));
+      it(`Class`, () => expect(isClass(Class)).toBe(TRUE));
+    });
+    // ... objects.
+    describe('object', () => {
+      it(`CLASS`, () => expect(isClass(CLASS)).toBe(FALSE));
+      it(`OBJECT_ONE`, () => expect(isClass(OBJECT_ONE)).toBe(FALSE));
+      it(`OBJECT_TWO`, () => expect(isClass(OBJECT_TWO)).toBe(FALSE));
+      it(`new Object(OBJECT_ONE_NEW})`, () => expect(isClass(OBJECT_ONE_NEW)).toBe(FALSE));
+      it(`new Object(OBJECT_TWO_NEW})`, () => expect(isClass(OBJECT_TWO_NEW)).toBe(FALSE));
+    });
+    // ... primitives.
+    describe(`primitive`, () => {
+      // bigint
+      describe(`bigint`, () => it(`${BIGINT}`, () => expect(isClass(BIGINT)).toBe(FALSE)));
+      // boolean
+      describe(`boolean`, () => {
+        it(`${TRUE}`, () => expect(isClass(TRUE)).toBe(FALSE));
+        it(`${FALSE}`, () => expect(isClass(FALSE)).toBe(FALSE));
+      });
+      // null
+      it(`${NULL}`, () => expect(isClass(NULL)).toBe(FALSE));
+      // number
+      describe(`number`, () => {
+        it(`${NUMBER}`, () => expect(isClass(NUMBER)).toBe(FALSE));
+        it(`Number(${NUMBER})`, () => expect(isClass(NUMBER_INSTANCE)).toBe(FALSE));
+      });
+      // string
+      describe(`string`, () => {
+        it(`${STRING}`, () => expect(isClass(STRING)).toBe(FALSE));
+        it(`String(${STRING})`, () => expect(isClass(STRING_INSTANCE)).toBe(FALSE));
+      });
+      // symbol
+      describe(`symbol`, () => {
+        it(`Symbol(${NUMBER})`, () => expect(isClass(SYMBOL_NUMBER)).toBe(FALSE));
+        it(`Symbol(${STRING})`, () => expect(isClass(SYMBOL_STRING)).toBe(FALSE));
+      });
+      // undefined
+      it(`${UNDEFINED}`, () => expect(isClass(UNDEFINED)).toBe(FALSE));
+      // ... object.
+      describe(`object`, () => {
+        // BigInt
+        describe(`BigInt`, () => it(`${BIGINT_EXPECTATION}`, () => expect(isClass(BIGINT_INSTANCE)).toBe(FALSE)));
+        // Boolean
+        describe(`Boolean`, () => {
+          it(`${TRUE_EXPECTATION}`, () => expect(isClass(TRUE_INSTANCE)).toBe(FALSE));
+          it(`${FALSE_EXPECTATION}`, () => expect(isClass(FALSE_INSTANCE)).toBe(FALSE));
+        });
+        // Number
+        describe(`Number`, () => it(`new Number(${NUMBER})`, () => expect(isClass(NUMBER_NEW_INSTANCE)).toBe(FALSE)));
+        // String
+        describe(`String`, () => it(`new String(${STRING})`, () => expect(isClass(STRING_NEW_INSTANCE)).toBe(FALSE)));
+      });
+    });
+  });
+});
diff --git a/packages/type/src/is/type/is-array.type.ts b/packages/type/src/is/type/is-array.type.ts
@@ -1,2 +1,2 @@
 import { ResultCallback } from '../../type/result-callback.type';
-export type IsArray = <Type>(value: any, callback?: ResultCallback) => value is Array<Type>;
+export type IsArray = <Type = any>(value: any, callback?: ResultCallback) => value is Array<Type>;
diff --git a/packages/type/src/is/type/is-class.type.ts b/packages/type/src/is/type/is-class.type.ts
@@ -1,2 +1,2 @@
 import { ResultCallback } from '../../type/result-callback.type';
-export type IsClass = <Class>(value: any, callback?: ResultCallback) => value is Class;
+export type IsClass = <Class = Function>(value: any, callback?: ResultCallback) => value is Class;
diff --git a/packages/type/src/is/type/is-instance.type.ts b/packages/type/src/is/type/is-instance.type.ts
@@ -1,3 +1,3 @@
 import { Constructor } from '../../type/constructor.type';
 import { ResultCallback } from '../../type/result-callback.type';
-export type IsInstance = <Obj>(value: any, instance: Constructor<Obj>, callback?: ResultCallback) => value is Obj;
+export type IsInstance = <Class>(value: any, instance: Constructor<Class>, callback?: ResultCallback) => value is Constructor<Class>;

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@angular-package/type",`
`3`		`- "version": "4.0.2",`
	`3`	`+ "version": "4.0.3",`
`4`	`4`	`"description": "Common types, type guards and type checkers.",`
`5`	`5`	`"author": "Angular Package <[email protected]> (https://wvvw.dev)",`
`6`	`6`	`"homepage": "https://github.com/angular-package/type#readme",`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`	`import { ResultCallback } from '../../type/result-callback.type';`
`2`		`-export type GuardObjectKey = <Obj = object>(value: Obj, key: keyof Obj \| (keyof Obj)[], callback?: ResultCallback) => value is Obj;`
	`2`	`+export type GuardObjectKey = <Obj>(value: Obj, key: keyof Obj \| (keyof Obj)[], callback?: ResultCallback) => value is Obj;`
`3`	`3`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`import { ResultCallback } from '../../type/result-callback.type';`
`2`		`-export type GuardObject = <Obj = object>(value: Obj, callback?: ResultCallback) => value is Obj;`
	`2`	`+export type GuardObject = <Obj>(value: Obj, callback?: ResultCallback) => value is Obj;`