Merge pull request #27 from angular-package/4.1.x

angularpackage · web-flow · commit 75b11585d5e5 · 2021-06-02T15:39:03.000+02:00
4.1.3 README.md
diff --git a/README.md b/README.md
diff --git a/src/guard/lib/guard-array.func.ts b/src/guard/lib/guard-array.func.ts
@@ -9,5 +9,7 @@ import { ResultCallback } from '../../type/result-callback.type';
  * @param callback An optional `ResultCallback` function to handle the result before returns.
  * @returns A `boolean` indicating whether or not the `value` is an `Array` of a generic `Type`.
  */
-export const guardArray: GuardArray = <Type>(value: Array<Type>, callback?: ResultCallback): value is Array<Type> =>
-  isArray<Type>(value, callback);
+export const guardArray: GuardArray = <Type>(
+  value: Array<Type>,
+  callback?: ResultCallback
+): value is Array<Type> => isArray<Type>(value, callback);
diff --git a/src/guard/lib/guard-big-int.func.ts b/src/guard/lib/guard-big-int.func.ts
@@ -9,5 +9,7 @@ import { ResultCallback } from '../../type/result-callback.type';
  * @param callback An optional `ResultCallback` function to handle the result before returns.
  * @returns A `boolean` indicating whether or not the `value` is a `bigint`.
  */
-export const guardBigInt: GuardBigInt = (value: bigint, callback?: ResultCallback): value is bigint =>
-  isBigInt(value, callback);
+export const guardBigInt: GuardBigInt = (
+  value: bigint,
+  callback?: ResultCallback
+): value is bigint => isBigInt(value, callback);
diff --git a/src/guard/lib/guard-boolean.func.ts b/src/guard/lib/guard-boolean.func.ts
@@ -10,5 +10,7 @@ import { ResultCallback } from '../../type/result-callback.type';
  * @param callback An optional `ResultCallback` function to handle the result before returns.
  * @returns A `boolean` indicating whether or not the `value` is a `boolean` type or `Boolean` object.
  */
-export const guardBoolean: GuardBoolean = <B extends AnyBoolean>(value: B, callback?: ResultCallback): value is B =>
-  isBoolean(value, callback);
+export const guardBoolean: GuardBoolean = <B extends AnyBoolean>(
+  value: B,
+  callback?: ResultCallback
+): value is B => isBoolean(value, callback);
diff --git a/src/guard/lib/guard-class.func.ts b/src/guard/lib/guard-class.func.ts
@@ -10,5 +10,7 @@ import { ResultCallback } from '../../type/result-callback.type';
  * @returns A `boolean` indicating whether or not the `value` is a generic `class`.
  */
 // tslint:disable-next-line: ban-types
-export const guardClass: GuardClass = <Class extends Function>(value: Class, callback?: ResultCallback): value is Class =>
-  isClass<Class>(value, callback);
+export const guardClass: GuardClass = <Class extends Function>(
+  value: Class,
+  callback?: ResultCallback
+): value is Class => isClass<Class>(value, callback);
diff --git a/src/guard/lib/guard-defined.func.ts b/src/guard/lib/guard-defined.func.ts
@@ -10,5 +10,7 @@ import { ResultCallback } from '../../type/result-callback.type';
  * @param callback An optional `ResultCallback` function to handle the result before returns.
  * @returns A `boolean` indicating whether or not the `value` is defined, if `undefined` then returns `never`.
  */
-export const guardDefined: GuardDefined = <Type>(value: Defined<Type>, callback?: ResultCallback): value is Defined<Type> =>
-  isDefined(value, callback);
+export const guardDefined: GuardDefined = <Type>(
+  value: Defined<Type>,
+  callback?: ResultCallback
+): value is Defined<Type> => isDefined(value, callback);
diff --git a/src/guard/lib/guard-function.func.ts b/src/guard/lib/guard-function.func.ts
@@ -10,5 +10,7 @@ import { ResultCallback } from '../../type/result-callback.type';
  * @param callback An optional `ResultCallback` function to handle the result before returns.
  * @returns A `boolean` indicating whether or not the `value` is a `Func`.
  */
-export const guardFunction: GuardFunction = (value: Func, callback?: ResultCallback): value is Func =>
-  isFunction(value, callback);
+export const guardFunction: GuardFunction = (
+  value: Func,
+  callback?: ResultCallback
+): value is Func => isFunction(value, callback);
diff --git a/src/guard/lib/guard-instance.func.ts b/src/guard/lib/guard-instance.func.ts
@@ -12,6 +12,8 @@ import { ResultCallback } from '../../type/result-callback.type';
  * @param callback An optional `ResultCallback` function to handle the result before returns.
  * @returns A `boolean` indicating whether or not the `value` is an `instance` of a generic `Obj`.
  */
-export const guardInstance: GuardInstance =
-  <Obj extends object>(value: Obj, constructor: Constructor<Obj>, callback?: ResultCallback): value is Obj =>
-    isInstance<Obj>(value, constructor, callback);
+export const guardInstance: GuardInstance = <Obj extends object>(
+  value: Obj,
+  constructor: Constructor<Obj>,
+  callback?: ResultCallback
+): value is Obj => isInstance<Obj>(value, constructor, callback);
diff --git a/src/guard/lib/guard-key.func.ts b/src/guard/lib/guard-key.func.ts
@@ -10,5 +10,7 @@ import { ResultCallback } from '../../type/result-callback.type';
  * @param callback An optional `ResultCallback` function to handle the result before returns.
  * @returns A `boolean` indicating whether or not the `value` is a `Key`.
  */
-export const guardKey: GuardKey = (value: Key, callback?: ResultCallback): value is Key =>
-  isKey(value, callback);
+export const guardKey: GuardKey = (
+  value: Key,
+  callback?: ResultCallback
+): value is Key => isKey(value, callback);
diff --git a/src/guard/lib/guard-null.func.ts b/src/guard/lib/guard-null.func.ts
@@ -9,5 +9,7 @@ import { ResultCallback } from '../../type/result-callback.type';
  * @param callback An optional `ResultCallback` function to handle the result before returns.
  * @returns A `boolean` indicating whether or not the `value` is a `null`.
  */
-export const guardNull: GuardNull = (value: null, callback?: ResultCallback): value is null =>
-  isNull(value, callback);
+export const guardNull: GuardNull = (
+  value: null,
+  callback?: ResultCallback
+): value is null => isNull(value, callback);
diff --git a/src/guard/lib/guard-number.func.ts b/src/guard/lib/guard-number.func.ts
@@ -10,5 +10,7 @@ import { ResultCallback } from '../../type/result-callback.type';
  * @param callback An optional `ResultCallback` function to handle the result before returns.
  * @returns A `boolean` indicating whether or not the `value` is a `number` type or `Number` object.
  */
-export const guardNumber: GuardNumber = <N extends AnyNumber>(value: N, callback?: ResultCallback): value is N =>
-  isNumber(value, callback);
+export const guardNumber: GuardNumber = <N extends AnyNumber>(
+  value: N,
+  callback?: ResultCallback
+): value is N => isNumber(value, callback);
diff --git a/src/guard/lib/guard-object-key.func.ts b/src/guard/lib/guard-object-key.func.ts
@@ -10,6 +10,8 @@ import { ResultCallback } from '../../type/result-callback.type';
  * @param callback An optional `ResultCallback` function to handle the 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 extends object>(value: Obj, key: keyof Obj | (keyof Obj)[], callback?: ResultCallback): value is Obj =>
-    isObjectKey<Obj>(value, key, callback);
+export const guardObjectKey: GuardObjectKey = <Obj extends object>(
+  value: Obj,
+  key: keyof Obj | (keyof Obj)[],
+  callback?: ResultCallback
+): value is Obj => isObjectKey<Obj>(value, key, callback);
diff --git a/src/guard/lib/guard-object-keys.func.ts b/src/guard/lib/guard-object-keys.func.ts
@@ -8,6 +8,7 @@ import { GuardObjectKeys } from '../type/guard-object-keys.type';
  * @param keys A rest parameter single key of `Obj` or an array of keys of `Obj`, as the name of the property that the `value` contains.
  * @returns A `boolean` indicating whether or not the `value` is an `object` with some of its own specified `keys`.
  */
-export const guardObjectKeys: GuardObjectKeys =
-  <Obj extends object>(value: Obj, ...keys: (keyof Obj | Array<keyof Obj>)[]): value is Obj =>
-    isObjectKeys<Obj>(value, ...keys);
+export const guardObjectKeys: GuardObjectKeys = <Obj extends object>(
+  value: Obj,
+  ...keys: (keyof Obj | Array<keyof Obj>)[]
+): value is Obj => isObjectKeys<Obj>(value, ...keys);
diff --git a/src/guard/lib/guard-object.func.ts b/src/guard/lib/guard-object.func.ts
@@ -9,5 +9,7 @@ import { ResultCallback } from '../../type/result-callback.type';
  * @param callback An optional `ResultCallback` function to handle the result before returns.
  * @returns A `boolean` indicating whether or not the `value` is an `object` of a generic `Obj`.
  */
-export const guardObject: GuardObject = <Obj extends object>(value: Obj, callback?: ResultCallback): value is Obj =>
-  isObject<Obj>(value, callback);
+export const guardObject: GuardObject = <Obj extends object>(
+  value: Obj,
+  callback?: ResultCallback
+): value is Obj => isObject<Obj>(value, callback);
diff --git a/src/guard/lib/guard-primitive.func.ts b/src/guard/lib/guard-primitive.func.ts
@@ -12,6 +12,8 @@ import { ResultCallback } from '../../type/result-callback.type';
  * @param callback An optional `ResultCallback` function to handle the result before returns.
  * @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 =>
-    isPrimitive<Type>(value, type, callback);
+export const guardPrimitive: GuardPrimitive = <Type extends Primitive>(
+  value: Type,
+  type: Primitives,
+  callback?: ResultCallback
+): value is Type => isPrimitive<Type>(value, type, callback);
diff --git a/src/guard/lib/guard-string.func.ts b/src/guard/lib/guard-string.func.ts
@@ -10,5 +10,7 @@ import { ResultCallback } from '../../type/result-callback.type';
  * @param callback An optional `ResultCallback` function to handle the result before returns.
  * @returns A `boolean` indicating whether or not the `value` is a `string` type or `String` object.
  */
-export const guardString: GuardString = <S extends AnyString>(value: S, callback?: ResultCallback): value is S =>
-  isString(value, callback);
+export const guardString: GuardString = <S extends AnyString>(
+  value: S,
+  callback?: ResultCallback
+): value is S => isString(value, callback);
diff --git a/src/guard/lib/guard-symbol.func.ts b/src/guard/lib/guard-symbol.func.ts
@@ -6,8 +6,10 @@ import { ResultCallback } from '../../type/result-callback.type';
 /**
  * Guard the `value` to be a `symbol`.
  * @param value A `symbol` type `value` to guard.
- * @param callback Optional `ResultCallback` function to handle result before returns.
+ * @param callback An optional `ResultCallback` function to handle the result before returns.
  * @returns A `boolean` indicating whether or not the `value` is a `symbol`.
  */
-export const guardSymbol: GuardSymbol = (value: symbol, callback?: ResultCallback): value is symbol =>
-  isSymbol(value, callback);
+export const guardSymbol: GuardSymbol = (
+  value: symbol,
+  callback?: ResultCallback
+): value is symbol => isSymbol(value, callback);
diff --git a/src/guard/lib/guard-type.func.ts b/src/guard/lib/guard-type.func.ts
@@ -12,5 +12,9 @@ import { Types } from '../../type/types.type';
  * @param callback An optional `ResultCallback` function to handle the result before returns.
  * @returns A `boolean` indicating whether or not the `value` is a type from the `Types`.
  */
-export const guardType: GuardType = <T extends Type>(value: T, type: Types<T>, callback?: ResultCallback): value is T  =>
-  isType<T>(value, type, callback);
+export const guardType: GuardType = <T extends Type>(
+  value: T,
+  type: Types<T>,
+  callback?: ResultCallback
+): value is T => isType<T>(value, type, callback);
+
diff --git a/src/guard/lib/guard-undefined.func.ts b/src/guard/lib/guard-undefined.func.ts
@@ -9,5 +9,7 @@ import { ResultCallback } from '../../type/result-callback.type';
  * @param callback An optional `ResultCallback` function to handle the result before returns.
  * @returns A `boolean` indicating whether or not the `value` is `undefined`.
  */
-export const guardUndefined: GuardUndefined = (value: undefined, callback?: ResultCallback): value is undefined =>
-  isUndefined(value, callback);
+export const guardUndefined: GuardUndefined = (
+  value: undefined,
+  callback?: ResultCallback
+): value is undefined => isUndefined(value, callback);
diff --git a/src/is/lib/is-big-int.func.ts b/src/is/lib/is-big-int.func.ts
@@ -7,8 +7,11 @@ import { ResultCallback } from '../../type/result-callback.type';
 /**
  * Checks if any `value` is a `bigint` type.
  * @param value Any `value` to check.
- * @param callback `ResultCallback` function to handle result before returns.
+ * @param callback A `ResultCallback` function to handle the result before returns.
  * @returns A `boolean` indicating whether or not the `value` is a `bigint`.
  */
-export const isBigInt: IsBigInt = (value: any, callback: ResultCallback = resultCallback): value is bigint =>
+export const isBigInt: IsBigInt = (
+  value: any,
+  callback: ResultCallback = resultCallback
+): value is bigint =>
   callback(typeOf(value) === 'bigint' && typeof value === 'bigint', value);
diff --git a/src/is/lib/is-boolean-object.func.ts b/src/is/lib/is-boolean-object.func.ts
@@ -6,8 +6,17 @@ import { ResultCallback } from '../../type/result-callback.type';
 /**
  * Checks if any `value` is an `object` type and instance of `Boolean` and `Object`.
  * @param value Any `value` to check.
- * @param callback `ResultCallback` function to handle result before returns.
+ * @param callback A `ResultCallback` function to handle the result before returns.
  * @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, value);
+export const isBooleanObject: IsBooleanObject = (
+  value: any,
+  callback: ResultCallback = resultCallback
+// tslint:disable-next-line: ban-types
+): value is Boolean =>
+  callback(
+    typeof value === 'object' &&
+    value instanceof Boolean === true &&
+    value instanceof Object === true,
+    value
+  );
diff --git a/src/is/lib/is-boolean-type.func.ts b/src/is/lib/is-boolean-type.func.ts
@@ -6,10 +6,13 @@ import { ResultCallback } from '../../type/result-callback.type';
 /**
  * Checks if any `value` is a `boolean` type not an instance of `Boolean` and `Object`, and equal to `true` or `false`.
  * @param value Any `value` to check.
- * @param callback `ResultCallback` function to handle result before returns.
+ * @param callback A `ResultCallback` function to handle the result before returns.
  * @returns A `boolean` indicating whether or not the `value` is a `boolean` type.
  */
-export const isBooleanType: IsBooleanType = (value: any, callback: ResultCallback = resultCallback): value is boolean =>
+export const isBooleanType: IsBooleanType = (
+  value: any,
+  callback: ResultCallback = resultCallback
+): value is boolean =>
   callback(
     value instanceof Boolean === false &&
     value instanceof Object === false &&
diff --git a/src/is/lib/is-boolean.func.ts b/src/is/lib/is-boolean.func.ts
@@ -12,5 +12,12 @@ import { ResultCallback } from '../../type/result-callback.type';
  * @param callback `ResultCallback` function to handle result before returns.
  * @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);
+export const isBoolean: IsBoolean = (
+  value: any,
+  callback: ResultCallback = resultCallback
+): value is boolean =>
+  callback(
+    typeOf(value) === 'boolean' &&
+    (isBooleanType(value) || isBooleanObject(value)),
+    value
+  );
diff --git a/src/is/lib/is-class.func.ts b/src/is/lib/is-class.func.ts
@@ -7,18 +7,20 @@ import { ResultCallback } from '../../type/result-callback.type';
 /**
  * Checks if any value is a `function` type, an instance of `Function` and `Object` as a generic `Class` type of `class`.
  * @param value Any `value` to check.
- * @param callback A `ResultCallback` function to handle result before returns.
+ * @param callback A `ResultCallback` function to handle the result before returns.
  * @returns A `boolean` indicating whether or not the `value` is a `class`.
  */
-export const isClass: IsClass = <Class = Function>(value: any, callback: ResultCallback = resultCallback): value is Class =>
+// tslint:disable-next-line: ban-types
+export const isClass: IsClass = <Class = Function>(
+  value: any,
+  callback: ResultCallback = resultCallback
+): value is Class =>
   callback(
-    (
-      typeOf(value) === 'function' &&
+    typeOf(value) === 'function' &&
       typeof value === 'function' &&
       value instanceof Function === true &&
       value instanceof Object === true
-    ) ?
-      /class/.test(Function.prototype.toString.call(value).slice(0, 5))
+      ? /class/.test(Function.prototype.toString.call(value).slice(0, 5))
       : false,
     value
   );
diff --git a/src/is/lib/is-function.func.ts b/src/is/lib/is-function.func.ts
@@ -8,18 +8,20 @@ import { ResultCallback } from '../../type/result-callback.type';
 /**
  * Checks if any `value` is a `function` type, an instance of `Function` and `Object`.
  * @param value Any `value` to check.
- * @param callback `ResultCallback` function to handle result before returns.
+ * @param callback A `ResultCallback` function to handle the result before returns.
  * @returns A `boolean` indicating whether or not the `value` is a `function`.
  */
-export const isFunction: IsFunction = (value: any, callback: ResultCallback = resultCallback): value is Func =>
+export const isFunction: IsFunction = (
+  value: any,
+  callback: ResultCallback = resultCallback
+): value is Func =>
   callback(
-    (
-      typeOf(value) === 'function' &&
+    typeOf(value) === 'function' &&
       typeof value === 'function' &&
       value instanceof Function === true &&
       value instanceof Object === true
-    ) ?
-      /class/.test(Function.prototype.toString.call(value).slice(0, 5)) === false
+      ? /class/.test(Function.prototype.toString.call(value).slice(0, 5)) ===
+      false
       : false,
     value
   );
diff --git a/src/is/lib/is-instance.func.ts b/src/is/lib/is-instance.func.ts
@@ -14,13 +14,16 @@ import { ResultCallback } from '../../type/result-callback.type';
  * @param callback A `ResultCallback` function to handle the result before returns.
  * @returns  A `boolean` indicating whether or not the `value` is an instance of a generic `Obj`.
  */
-export const isInstance: IsInstance =
-  <Obj>(value: any, constructor: Constructor<Obj>, callback: ResultCallback = resultCallback): value is Obj =>
-    callback(
-      isObject<Obj>(value) ?
-        isClass<Obj>(constructor) || isFunction(constructor) ?
-          value instanceof constructor === true
-          : false
-        : false,
-      value
-    );
+export const isInstance: IsInstance = <Obj>(
+  value: any,
+  constructor: Constructor<Obj>,
+  callback: ResultCallback = resultCallback
+): value is Obj =>
+  callback(
+    isObject<Obj>(value)
+      ? isClass<Obj>(constructor) || isFunction(constructor)
+        ? value instanceof constructor === true
+        : false
+      : false,
+    value
+  );
diff --git a/src/is/lib/is-key.func.ts b/src/is/lib/is-key.func.ts
@@ -10,8 +10,14 @@ import { ResultCallback } from '../../type/result-callback.type';
 /**
  * Checks if any `value` is one of the `string`, `number`, or `symbol`.
  * @param value Any `value` to check.
- * @param callback `ResultCallback` function to handle result before returns.
+ * @param callback A `ResultCallback` function to handle the result before returns.
  * @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(isStringType(value) || isNumberType(value) || isSymbol(value), value);
+export const isKey: IsKey = (
+  value: any,
+  callback: ResultCallback = resultCallback
+): value is Key =>
+  callback(
+    isStringType(value) || isNumberType(value) || isSymbol(value),
+    value
+  );
diff --git a/src/is/lib/is-null.func.ts b/src/is/lib/is-null.func.ts
@@ -7,8 +7,14 @@ import { ResultCallback } from '../../type/result-callback.type';
 /**
  * Checks if any `value` is an `object` type and equal to `null`.
  * @param value Any `value` to check.
- * @param callback `ResultCallback` function to handle result before returns.
+ * @param callback A `ResultCallback` function to handle the result before returns.
  * @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, value);
+export const isNull: IsNull = (
+  value: any,
+  callback: ResultCallback = resultCallback
+): value is null =>
+  callback(
+    typeOf(value) === 'null' && typeof value === 'object' && value === null,
+    value
+  );
diff --git a/src/is/lib/is-number-object.func.ts b/src/is/lib/is-number-object.func.ts
@@ -6,8 +6,17 @@ import { ResultCallback } from '../../type/result-callback.type';
 /**
  * Checks if any `value` is an `object` type and instance of `Number` and `Object`.
  * @param value Any `value` to check.
- * @param callback `ResultCallback` function to handle result before returns.
+ * @param callback A `ResultCallback` function to handle the result before returns.
  * @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, value);
+export const isNumberObject: IsNumberObject = (
+  value: any,
+  callback: ResultCallback = resultCallback
+// tslint:disable-next-line: ban-types
+): value is Number =>
+  callback(
+    typeof value === 'object' &&
+    value instanceof Number === true &&
+    value instanceof Object === true,
+    value
+  );
diff --git a/src/is/lib/is-number-type.func.ts b/src/is/lib/is-number-type.func.ts
diff --git a/src/is/lib/is-number.func.ts b/src/is/lib/is-number.func.ts
diff --git a/src/is/lib/is-object-key-in.func.ts b/src/is/lib/is-object-key-in.func.ts
diff --git a/src/is/lib/is-object-key.func.ts b/src/is/lib/is-object-key.func.ts
diff --git a/src/is/lib/is-object-keys.func.ts b/src/is/lib/is-object-keys.func.ts
diff --git a/src/is/lib/is-object.func.ts b/src/is/lib/is-object.func.ts
diff --git a/src/is/lib/is-primitive.func.ts b/src/is/lib/is-primitive.func.ts
diff --git a/src/is/lib/is-string-object.func.ts b/src/is/lib/is-string-object.func.ts
diff --git a/src/is/lib/is-string-type.func.ts b/src/is/lib/is-string-type.func.ts
diff --git a/src/is/lib/is-string.func.ts b/src/is/lib/is-string.func.ts
diff --git a/src/is/lib/is-symbol.func.ts b/src/is/lib/is-symbol.func.ts
diff --git a/src/is/lib/is-type.func.ts b/src/is/lib/is-type.func.ts
diff --git a/src/is/lib/is-undefined.func.ts b/src/is/lib/is-undefined.func.ts
