chore(is): prettier code formatter on functions and update jsdoc

sciborrudnicki · sciborrudnicki · commit d33fdfb7b01f · 2021-06-02T15:34:12.000+02:00
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
@@ -6,8 +6,16 @@ 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 `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', value);
+export const isNumberType: IsNumberType = (
+  value: any,
+  callback: ResultCallback = resultCallback
+): value is number =>
+  callback(
+    value instanceof Number === false &&
+    value instanceof Object === false &&
+    typeof value === 'number',
+    value
+  );
diff --git a/src/is/lib/is-number.func.ts b/src/is/lib/is-number.func.ts
@@ -9,8 +9,16 @@ import { ResultCallback } from '../../type/result-callback.type';
 /**
  * Checks if any `value` is a `number` type not an instance of `Number` and `Object` or `object` type 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` type or `Number` object.
  */
-export const isNumber: IsNumber = (value: any, callback: ResultCallback = resultCallback): value is number =>
-  callback(typeOf(value) === 'number' && isFinite(value) === true && (isNumberType(value) || isNumberObject(value)), value);
+export const isNumber: IsNumber = (
+  value: any,
+  callback: ResultCallback = resultCallback
+): value is number =>
+  callback(
+    typeOf(value) === 'number' &&
+    isFinite(value) === true &&
+    (isNumberType(value) || isNumberObject(value)),
+    value
+  );
diff --git a/src/is/lib/is-object-key-in.func.ts b/src/is/lib/is-object-key-in.func.ts
@@ -11,18 +11,21 @@ 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.
+ * @param callback A `ResultCallback` function to handle the result before returns.
  * @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/src/is/lib/is-object-key.func.ts b/src/is/lib/is-object-key.func.ts
@@ -11,18 +11,23 @@ import { ResultCallback } from '../../type/result-callback.type';
  * Checks if any `value` is an `object` with its own specified `key` of the `Key` type.
  * @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 the `value`.
- * @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 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/src/is/lib/is-object-keys.func.ts b/src/is/lib/is-object-keys.func.ts
@@ -15,11 +15,14 @@ export const isObjectKeys: IsObjectKeys = <Type = object>(
   value: any,
   ...keys: (Key | Array<Key>)[]
 ): value is Type =>
-  isObject<Type>(value) ?
-    keys.some(key =>
-      isArray(key) ?
-        key.every(k => isKey(k) ? ({}).hasOwnProperty.call(value, k) === true : false)
-        : isKey(key) ?
-          ({}).hasOwnProperty.call(value, key) === true
-          : false)
+  isObject<Type>(value)
+    ? keys.some((key) =>
+      isArray(key)
+        ? key.every((k) =>
+          isKey(k) ? {}.hasOwnProperty.call(value, k) === true : false
+        )
+        : isKey(key)
+          ? {}.hasOwnProperty.call(value, key) === true
+          : false
+    )
     : false;
diff --git a/src/is/lib/is-object.func.ts b/src/is/lib/is-object.func.ts
@@ -7,8 +7,16 @@ import { ResultCallback } from '../../type/result-callback.type';
 /**
  * Checks if any `value` is an `object` of a generic `Obj` type and `Object` instance.
  * @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 an `object`.
  */
-export const isObject: IsObject = <Obj = object>(value: any, callback: ResultCallback = resultCallback): value is Obj =>
-  callback(typeOf(value) === 'object' && typeof value === 'object' && value instanceof Object === true, value);
+export const isObject: IsObject = <Obj = object>(
+  value: any,
+  callback: ResultCallback = resultCallback
+): value is Obj =>
+  callback(
+    typeOf(value) === 'object' &&
+    typeof value === 'object' &&
+    value instanceof Object === true,
+    value
+  );
diff --git a/src/is/lib/is-primitive.func.ts b/src/is/lib/is-primitive.func.ts
@@ -16,7 +16,7 @@ import { ResultCallback } from '../../type/result-callback.type';
  * Checks if any `value` is the `Primitive` type from a `type` of the `Primitives` type.
  * @param value Any `value` to check if it's a `Primitive` from the `type`.
  * @param type A `string` type from the `Primitives` to check the `value`.
- * @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 `type` from the `Primitives`.
  */
 export const isPrimitive: IsPrimitive = <T extends Primitive>(
diff --git a/src/is/lib/is-string-object.func.ts b/src/is/lib/is-string-object.func.ts
@@ -6,8 +6,17 @@ import { ResultCallback } from '../../type/result-callback.type';
 /**
  * Checks if any `value` is an `object` type instance of `String` 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 `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', value);
+export const isStringObject: IsStringObject = (
+  value: any,
+  callback: ResultCallback = resultCallback
+// tslint:disable-next-line: ban-types
+): value is String =>
+  callback(
+    value instanceof Object === true &&
+    value instanceof String === true &&
+    typeof value === 'object',
+    value
+  );
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
