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

4.1.3

Author: angularpackage

README.md

@@ -1,6 +1,6 @@
 {
   "name": "@angular-package/type",
-  "version": "4.1.2",
+  "version": "4.1.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",

package-lock.json

@@ -5,8 +5,8 @@ import { GuardArray } from '../type/guard-array.type';
 import { ResultCallback } from '../../type/result-callback.type';
 /**
  * Guard the `value` to be an `Array` of a generic `Type`.
- * @param value A generic `Type` `Array` `value` to guard.
- * @param callback An optional `ResultCallback` function to handle result before returns.
+ * @param value An `Array` of a generic `Type`, by default type detected from the `value` - to guard.
+ * @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> =>

package.json

@@ -6,7 +6,7 @@ import { ResultCallback } from '../../type/result-callback.type';
 /**
  * Guard the `value` to be a `bigint`.
  * @param value A `bigint` 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 `bigint`.
  */
 export const guardBigInt: GuardBigInt = (value: bigint, callback?: ResultCallback): value is bigint =>

src/guard/lib/guard-array.func.ts

@@ -6,8 +6,8 @@ import { GuardBoolean } from '../type/guard-boolean.type';
 import { ResultCallback } from '../../type/result-callback.type';
 /**
  * Guard the `value` to be any type of a boolean.
- * @param value An `AnyBoolean` type from the `value` to guard.
- * @param callback An optional `ResultCallback` function to handle result before returns.
+ * @param value An `AnyBoolean` type `value`, by default of type detected from the `value` - to guard.
+ * @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 =>

src/guard/lib/guard-big-int.func.ts

@@ -5,9 +5,10 @@ import { GuardClass } from '../type/guard-class.type';
 import { ResultCallback } from '../../type/result-callback.type';
 /**
  * Guard the `value` to be a generic `Class` type of `class`.
- * @param value A generic `Class` type from the `value` to guard.
- * @param callback An Optional `ResultCallback` function to handle result before returns.
+ * @param value A `Function` type `value`, by default of a generic `Class` type detected from the `value` to guard.
+ * @param callback An optional `ResultCallback` function to handle the result before returns.
  * @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);

src/guard/lib/guard-boolean.func.ts

@@ -6,8 +6,8 @@ import { GuardDefined } from '../type/guard-defined.type';
 import { ResultCallback } from '../../type/result-callback.type';
 /**
  * Guard the `value` to be defined, not `undefined`.
- * @param value A generic `Type` type from the `value` to guard.
- * @param callback An optional `ResultCallback` function to handle result before returns.
+ * @param value A generic type `value`, by default of `Defined<Type>` type detected from the `value` to guard against `undefined`.
+ * @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> =>

src/guard/lib/guard-class.func.ts

@@ -7,7 +7,7 @@ import { ResultCallback } from '../../type/result-callback.type';
 /**
  * Guard the `value` to be a `Func` type.
  * @param value A `Func` 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 `Func`.
  */
 export const guardFunction: GuardFunction = (value: Func, callback?: ResultCallback): value is Func =>

src/guard/lib/guard-defined.func.ts

@@ -6,7 +6,8 @@ import { GuardInstance } from '../type/guard-instance.type';
 import { ResultCallback } from '../../type/result-callback.type';
 /**
  * Guard the `value` to be an `object` of a generic `Obj` type and an instance of `Constructor` type.
- * @param value A generic `Obj` type `value` to be an instance of the `constructor`.
+ * @param value An `object`, by default of a generic `Obj` type detected from the `value`
+ * to guard and check if it's a `constructor` instance.
  * @param constructor A class or function that specifies the type of the `constructor`.
  * @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`.