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

angularpackage · web-flow · commit fa9806115cbf · 2021-05-13T18:17:00.000+02:00
3.3.0
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": "3.2.4",
+  "version": "3.3.0",
   "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/is/index.ts b/packages/type/src/is/index.ts
@@ -14,6 +14,7 @@ export { isNumberObject } from './lib/is-number-object.func';
 export { isNumberType } from './lib/is-number-type.func';
 export { isObject } from './lib/is-object.func';
 export { isObjectKey } from './lib/is-object-key.func';
+export { isObjectKeyIn } from './lib/is-object-key-in.func';
 export { isPrimitive } from './lib/is-primitive.func';
 export { isString } from './lib/is-string.func';
 export { isStringObject } from './lib/is-string-object.func';
diff --git a/packages/type/src/is/interface/is.interface.ts b/packages/type/src/is/interface/is.interface.ts
@@ -2,26 +2,26 @@ import { IsArray } from '../type/is-array.type';
 import { IsBigInt } from '../type/is-big-int.type';
 import { IsBoolean } from '../type/is-boolean.type';
 import { IsBooleanObject } from '../type/is-boolean-object.type';
+import { IsBooleanType } from '../type/is-boolean-type.type';
 import { IsDefined } from '../type/is-defined.type';
 import { IsFunction } from '../type/is-function.type';
 import { IsInstance } from '../type/is-instance.type';
 import { IsKey } from '../type/is-key.type';
 import { IsNot } from '../not/interface/is-not.interface';
 import { IsNull } from '../type/is-null.type';
 import { IsNumber } from '../type/is-number.type';
+import { IsNumberObject } from '../type/is-number-object.type';
+import { IsNumberType } from '../type/is-number-type.type';
 import { IsObject } from '../type/is-object.type';
 import { IsObjectKey } from '../type/is-object-key.type';
+import { IsObjectKeyIn } from '../type/is-object-key-in.type';
 import { IsPrimitive } from '../type/is-primitive.type';
 import { IsString } from '../type/is-string.type';
 import { IsStringObject } from '../type/is-string-object.type';
 import { IsStringType } from '../type/is-string-type.type';
 import { IsSymbol } from '../type/is-symbol.type';
 import { IsType } from '../type/is-type.type';
 import { IsUndefined } from '../type/is-undefined.type';
-import { IsBooleanType } from '../type/is-boolean-type.type';
-import { IsNumberObject } from '../type/is-number-object.type';
-import { IsNumberType } from '../type/is-number-type.type';
-
 export interface Is {
   array: IsArray;
   bigInt: IsBigInt;
@@ -40,6 +40,7 @@ export interface Is {
   numberType: IsNumberType;
   object: IsObject;
   objectKey: IsObjectKey;
+  objectKeyIn: IsObjectKeyIn;
   primitive: IsPrimitive;
   string: IsString;
   stringObject: IsStringObject;
diff --git a/packages/type/src/is/lib/is-array.func.ts b/packages/type/src/is/lib/is-array.func.ts
@@ -16,5 +16,6 @@ export const isArray: IsArray = <Type>(value: any, callback: ResultCallback = re
     typeOf(value) === 'array' &&
     Array.isArray(value) === true &&
     value instanceof Array === true &&
-    typeof value === 'object'
+    typeof value === 'object',
+    value
   );
diff --git a/packages/type/src/is/lib/is-big-int.func.ts b/packages/type/src/is/lib/is-big-int.func.ts
@@ -12,4 +12,4 @@ import { ResultCallback } from '../../type/result-callback.type';
  * @returns A `boolean` indicating whether or not the `value` is a `bigint`.
  */
 export const isBigInt: IsBigInt = (value: any, callback: ResultCallback = resultCallback): value is bigint =>
-  callback(typeOf(value) === 'bigint' && typeof value === 'bigint');
+  callback(typeOf(value) === 'bigint' && typeof value === 'bigint', value);
diff --git a/packages/type/src/is/lib/is-boolean-object.func.ts b/packages/type/src/is/lib/is-boolean-object.func.ts
@@ -12,4 +12,4 @@ import { ResultCallback } from '../../type/result-callback.type';
  * @returns A `boolean` indicating whether or not the `value` is a `Boolean` instance.
  */
 export const isBooleanObject: IsBooleanObject = (value: any, callback: ResultCallback = resultCallback): value is boolean =>
-  callback(typeof value === 'object' && value instanceof Boolean === true && value instanceof Object === true);
+  callback(typeof value === 'object' && value instanceof Boolean === true && value instanceof Object === true, value);
diff --git a/packages/type/src/is/lib/is-boolean-type.func.ts b/packages/type/src/is/lib/is-boolean-type.func.ts
@@ -16,5 +16,6 @@ export const isBooleanType: IsBooleanType = (value: any, callback: ResultCallbac
     value instanceof Boolean === false &&
     value instanceof Object === false &&
     typeof value === 'boolean' &&
-    (value === true || value === false)
+    (value === true || value === false),
+    value
   );
diff --git a/packages/type/src/is/lib/is-boolean.func.ts b/packages/type/src/is/lib/is-boolean.func.ts
@@ -14,4 +14,4 @@ import { ResultCallback } from '../../type/result-callback.type';
  * @returns A `boolean` indicating whether or not the `value` is a `boolean`.
  */
 export const isBoolean: IsBoolean = (value: any, callback: ResultCallback = resultCallback): value is boolean =>
-  callback(typeOf(value) === 'boolean' && (isBooleanType(value) || isBooleanObject(value)));
+  callback(typeOf(value) === 'boolean' && (isBooleanType(value) || isBooleanObject(value)), value);
diff --git a/packages/type/src/is/lib/is-defined.func.ts b/packages/type/src/is/lib/is-defined.func.ts
@@ -12,4 +12,4 @@ import { ResultCallback } from '../../type/result-callback.type';
  * @returns A `boolean` indicating whether or not the `value` is defined, not `undefined`.
  */
 export const isDefined: IsDefined = (value: unknown, callback: ResultCallback = resultCallback): boolean =>
-  callback(typeOf(value) !== 'undefined' && typeof value !== 'undefined' && value !== undefined);
+  callback(typeOf(value) !== 'undefined' && typeof value !== 'undefined' && value !== undefined, value);
diff --git a/packages/type/src/is/lib/is-function.func.ts b/packages/type/src/is/lib/is-function.func.ts
@@ -17,5 +17,6 @@ export const isFunction: IsFunction = (value: any, callback: ResultCallback = re
     typeOf(value) === 'function' &&
     typeof value === 'function' &&
     value instanceof Function === true &&
-    value instanceof Object === true
+    value instanceof Object === true,
+    value
   );
diff --git a/packages/type/src/is/lib/is-instance.func.ts b/packages/type/src/is/lib/is-instance.func.ts
@@ -24,5 +24,6 @@ export const isInstance: IsInstance = <Obj>(
         isFunction(instance) ?
           value instanceof instance === true
         : false
-      : false
+      : false,
+      value
     );
diff --git a/packages/type/src/is/lib/is-key.func.ts b/packages/type/src/is/lib/is-key.func.ts
@@ -15,4 +15,4 @@ import { ResultCallback } from '../../type/result-callback.type';
  * @returns A `boolean` indicating whether or not the `value` is a `Key`.
  */
 export const isKey: IsKey = (value: any, callback: ResultCallback = resultCallback): value is Key =>
-  callback(isString(value) || isNumber(value) || isSymbol(value));
+  callback(isString(value) || isNumber(value) || isSymbol(value), value);
diff --git a/packages/type/src/is/lib/is-null.func.ts b/packages/type/src/is/lib/is-null.func.ts
@@ -12,4 +12,4 @@ import { ResultCallback } from '../../type/result-callback.type';
  * @returns A `boolean` indicating whether or not the `value` is `null`.
  */
 export const isNull: IsNull = (value: any, callback: ResultCallback = resultCallback): value is null =>
-  callback(typeOf(value) === 'null' && typeof value === 'object' && value === null);
+  callback(typeOf(value) === 'null' && typeof value === 'object' && value === null, value);
diff --git a/packages/type/src/is/lib/is-number-object.func.ts b/packages/type/src/is/lib/is-number-object.func.ts
@@ -11,4 +11,4 @@ import { ResultCallback } from '../../type/result-callback.type';
  * @returns A `boolean` indicating whether or not the `value` is a `Number` instance.
  */
 export const isNumberObject: IsNumberObject = (value: any, callback: ResultCallback = resultCallback): value is number =>
-  callback(typeof value === 'object' && value instanceof Number === true && value instanceof Object === true);
+  callback(typeof value === 'object' && value instanceof Number === true && value instanceof Object === true, value);
diff --git a/packages/type/src/is/lib/is-number-type.func.ts b/packages/type/src/is/lib/is-number-type.func.ts
@@ -11,4 +11,4 @@ import { ResultCallback } from '../../type/result-callback.type';
  * @returns A `boolean` indicating whether or not the `value` is a `number` type.
  */
 export const isNumberType: IsNumberType = (value: any, callback: ResultCallback = resultCallback): value is number =>
-  callback(value instanceof Number === false && value instanceof Object === false && typeof value === 'number');
+  callback(value instanceof Number === false && value instanceof Object === false && typeof value === 'number', value);
diff --git a/packages/type/src/is/lib/is-number.func.ts b/packages/type/src/is/lib/is-number.func.ts
@@ -14,4 +14,4 @@ import { ResultCallback } from '../../type/result-callback.type';
  * @returns A `boolean` indicating whether or not the `value` is a `number`.
  */
 export const isNumber: IsNumber = (value: any, callback: ResultCallback = resultCallback): value is number =>
-  callback(typeOf(value) === 'number' && isFinite(value) === true && (isNumberType(value) || isNumberObject(value)));
+  callback(typeOf(value) === 'number' && isFinite(value) === true && (isNumberType(value) || isNumberObject(value)), 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
@@ -0,0 +1,32 @@
+// Function.
+import { isArray } from './is-array.func';
+import { isKey } from './is-key.func';
+import { isObject } from './is-object.func';
+import { resultCallback } from '../../lib/result-callback.func';
+// Type.
+import { IsObjectKeyIn } from '../type/is-object-key-in.type';
+import { Key } from '../../type/key.type';
+import { ResultCallback } from '../../type/result-callback.type';
+/**
+ * Checks if any `value` is an `Object` with the `key` of the `Key` type by using the `in` operator.
+ * @param value Any `value` to check if it contains a specified `key`.
+ * @param key A `Key` type or an array of `Key` type to check in the `value`.
+ * @param callback `ResultCallback` function to handle result before returns.
+ * @callback `resultCallback`.
+ * @returns A `boolean` indicating whether or not the `value` is an `object` with the keys.
+ */
+export const isObjectKeyIn: IsObjectKeyIn = <Type extends 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
@@ -27,5 +27,6 @@ export const isObjectKey: IsObjectKey = <Type extends object>(
       : isKey(key) ?
           ({}).hasOwnProperty.call(value, key)
         : false
-    : false
+    : false,
+    value
   );
diff --git a/packages/type/src/is/lib/is-string-gen.func.ts b/packages/type/src/is/lib/is-string-gen.func.ts
@@ -0,0 +1,13 @@
+
+function* isStringGenerator(value: any): Generator {
+  yield typeOf(value) === 'string';
+  yield isStringType(value);
+  yield isStringObject(value);
+}
+
+function isStringChecks(value: any, callback: any) {
+  const gen: Generator = isStringGenerator(value);
+  for (const val of gen) {
+    callback(gen);
+  }
+}
diff --git a/packages/type/src/is/lib/is-string-object.func.ts b/packages/type/src/is/lib/is-string-object.func.ts
@@ -11,4 +11,4 @@ import { ResultCallback } from '../../type/result-callback.type';
  * @returns A `boolean` indicating whether or not the `value` is a `String` instance.
  */
 export const isStringObject: IsStringObject = (value: any, callback: ResultCallback = resultCallback): value is string =>
-  callback(value instanceof Object === true && value instanceof String === true && typeof value === 'object');
+  callback(value instanceof Object === true && value instanceof String === true && typeof value === 'object', value);
diff --git a/packages/type/src/is/lib/is-string-type.func.ts b/packages/type/src/is/lib/is-string-type.func.ts
@@ -11,4 +11,4 @@ import { ResultCallback } from '../../type/result-callback.type';
  * @returns A `boolean` indicating whether or not the value is a `string`.
  */
 export const isStringType: IsStringType = (value: any, callback: ResultCallback = resultCallback): value is string =>
-  callback(value instanceof Object === false && value instanceof String === false && typeof value === 'string');
+  callback(value instanceof Object === false && value instanceof String === false && typeof value === 'string', value);
diff --git a/packages/type/src/is/lib/is-string.func.ts b/packages/type/src/is/lib/is-string.func.ts
@@ -14,4 +14,4 @@ import { ResultCallback } from '../../type/result-callback.type';
  * @returns A `boolean` indicating whether or not the `value` is a `string`.
  */
 export const isString: IsString = (value: any, callback: ResultCallback = resultCallback): value is string =>
-  callback(typeOf(value) === 'string' && (isStringType(value) || isStringObject(value)));
+  callback(typeOf(value) === 'string' && (isStringType(value) || isStringObject(value)), value);
diff --git a/packages/type/src/is/lib/is-symbol.func.ts b/packages/type/src/is/lib/is-symbol.func.ts
@@ -7,9 +7,9 @@ import { ResultCallback } from '../../type/result-callback.type';
 /**
  * Checks if any `value` is a `symbol` type.
  * @param value Any `value` to check.
- * @param callback `ResultCallback` function to handle result before returns.
+ * @param callback A `ResultCallback` function to handle result before returns.
  * @callback `resultCallback`.
  * @returns A `boolean` indicating whether or not the `value` is a `symbol`.
  */
 export const isSymbol: IsSymbol = (value: any, callback: ResultCallback = resultCallback): value is symbol =>
-  callback(typeOf(value) === 'symbol' && typeof value === 'symbol');
+  callback(typeOf(value) === 'symbol' && typeof value === 'symbol', value);
diff --git a/packages/type/src/is/lib/is-undefined.func.ts b/packages/type/src/is/lib/is-undefined.func.ts
@@ -12,4 +12,4 @@ import { ResultCallback } from '../../type/result-callback.type';
  * @returns A `boolean` indicating whether or not the `value` is `undefined`.
  */
 export const isUndefined: IsUndefined = (value: any, callback: ResultCallback = resultCallback): value is undefined =>
-  callback(typeOf(value) === 'undefined' && typeof value === 'undefined' && value === undefined);
+  callback(typeOf(value) === 'undefined' && typeof value === 'undefined' && value === undefined, value);
diff --git a/packages/type/src/is/lib/is.object.ts b/packages/type/src/is/lib/is.object.ts
@@ -14,6 +14,7 @@ import { isNumberObject } from './is-number-object.func';
 import { isNumberType } from './is-number-type.func';
 import { isObject } from './is-object.func';
 import { isObjectKey } from './is-object-key.func';
+import { isObjectKeyIn } from './is-object-key-in.func';
 import { isPrimitive } from './is-primitive.func';
 import { isString } from './is-string.func';
 import { isStringObject } from './is-string-object.func';
@@ -44,6 +45,7 @@ export const is: Is = {
   numberType: isNumberType,
   object: isObject,
   objectKey: isObjectKey,
+  objectKeyIn: isObjectKeyIn,
   primitive: isPrimitive,
   string: isString,
   stringObject: isStringObject,
diff --git a/packages/type/src/is/not/lib/is-not-boolean.func.ts b/packages/type/src/is/not/lib/is-not-boolean.func.ts
@@ -17,5 +17,6 @@ export const isNotBoolean: IsNotBoolean = (value: unknown, callback: ResultCallb
     typeof value !== 'boolean' &&
     value instanceof Boolean === false &&
     value !== true &&
-    value !== false
+    value !== false,
+    value
   );
diff --git a/packages/type/src/is/not/lib/is-not-defined.func.ts b/packages/type/src/is/not/lib/is-not-defined.func.ts
@@ -12,4 +12,4 @@ import { ResultCallback } from '../../../type/result-callback.type';
  * @returns A `boolean` indicating whether or not the `value` is not defined.
  */
 export const isNotDefined: IsNotDefined = (value: unknown, callback: ResultCallback = resultCallback): boolean =>
-  callback(typeOf(value) === 'undefined' && typeof value === 'undefined' && value === undefined);
+  callback(typeOf(value) === 'undefined' && typeof value === 'undefined' && value === undefined, value);
diff --git a/packages/type/src/is/not/lib/is-not-function.func.ts b/packages/type/src/is/not/lib/is-not-function.func.ts
@@ -12,4 +12,4 @@ import { ResultCallback } from '../../../type/result-callback.type';
  * @returns A `boolean` indicating whether or not the `value` is not a `function`.
  */
 export const isNotFunction: IsNotFunction = (value: unknown, callback: ResultCallback = resultCallback): boolean =>
-  callback(typeOf(value) !== 'function' && typeof value !== 'function' && value instanceof Function === false);
+  callback(typeOf(value) !== 'function' && typeof value !== 'function' && value instanceof Function === false, value);
diff --git a/packages/type/src/is/not/lib/is-not-null.func.ts b/packages/type/src/is/not/lib/is-not-null.func.ts
@@ -12,4 +12,4 @@ import { ResultCallback } from '../../../type/result-callback.type';
  * @returns A `boolean` indicating whether or not the `value` is not `null`.
  */
 export const isNotNull: IsNotNull = (value: unknown, callback: ResultCallback = resultCallback): boolean =>
-  callback(typeOf(value) !== 'null' && value !== null);
+  callback(typeOf(value) !== 'null' && value !== null, value);
diff --git a/packages/type/src/is/not/lib/is-not-number.func.ts b/packages/type/src/is/not/lib/is-not-number.func.ts
@@ -16,5 +16,6 @@ export const isNotNumber: IsNotNumber = (value: any, callback: ResultCallback =
   callback(
     typeOf(value) !== 'number' &&
     typeof value !== 'number' &&
-    value instanceof Number === false
+    value instanceof Number === false,
+    value
   );
diff --git a/packages/type/src/is/not/lib/is-not-string.func.ts b/packages/type/src/is/not/lib/is-not-string.func.ts
@@ -12,4 +12,4 @@ import { ResultCallback } from '../../../type/result-callback.type';
  * @returns A `boolean` indicating whether or not the `value` is not a `string`.
  */
 export const isNotString: IsNotString = (value: unknown, callback: ResultCallback = resultCallback): boolean =>
-  callback(typeOf(value) !== 'string' && typeof value !== 'string' && value instanceof String === false);
+  callback(typeOf(value) !== 'string' && typeof value !== 'string' && value instanceof String === false, value);
diff --git a/packages/type/src/is/not/lib/is-not-undefined.func.ts b/packages/type/src/is/not/lib/is-not-undefined.func.ts
@@ -12,4 +12,4 @@ import { ResultCallback } from '../../../type/result-callback.type';
  * @returns A `boolean` indicating whether or not the `value` is not `undefined`.
  */
 export const isNotUndefined: IsNotUndefined = (value: unknown, callback: ResultCallback = resultCallback): boolean =>
-  callback(typeOf(value) !== 'undefined' && typeof value !== 'undefined' && value !== undefined);
+  callback(typeOf(value) !== 'undefined' && typeof value !== 'undefined' && value !== undefined, value);
diff --git a/packages/type/src/is/test/is-object-key-in.spec.ts b/packages/type/src/is/test/is-object-key-in.spec.ts
diff --git a/packages/type/src/is/test/is-object-key.spec.ts b/packages/type/src/is/test/is-object-key.spec.ts
diff --git a/packages/type/src/is/test/is-object.spec.ts b/packages/type/src/is/test/is-object.spec.ts
diff --git a/packages/type/src/is/test/is.spec.ts b/packages/type/src/is/test/is.spec.ts
diff --git a/packages/type/src/is/type/is-object-key-in.type.ts b/packages/type/src/is/type/is-object-key-in.type.ts
diff --git a/packages/type/src/lib/result-callback.func.ts b/packages/type/src/lib/result-callback.func.ts
diff --git a/packages/type/src/public-api.ts b/packages/type/src/public-api.ts
diff --git a/packages/type/src/type/result-callback.type.ts b/packages/type/src/type/result-callback.type.ts

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@angular-package/type",`
`3`		`- "version": "3.2.4",`
	`3`	`+ "version": "3.3.0",`
`4`	`4`	`"description": "Common types, type guards and type checkers.",`
`5`	`5`	`"author": "Angular Package <angular-package@wvvw.dev> (https://wvvw.dev)",`
`6`	`6`	`"homepage": "https://github.com/angular-package/type#readme",`