Merge pull request #12 from angular-package/3.4.x

3.4.0

Author: angularpackage

README.md

@@ -1,6 +1,6 @@
 {
   "name": "@angular-package/type",
-  "version": "3.3.2",
+  "version": "3.4.0",
   "description": "Common types, type guards and type checkers.",
   "author": "Angular Package <[email protected]> (https://wvvw.dev)",
   "homepage": "https://github.com/angular-package/type#readme",

README.temp.md

@@ -1,7 +1,7 @@
 import { check } from './check-args.func';
 /**
  * Checks if any of all the values are a `string`.
- * @param value Any arguments to check if they're all a `'string`.
- * @returns A `boolean` indicating whether or not all the `values` are an `Array`.
+ * @param value Any values to check.
+ * @returns A `boolean` indicating whether or not all the values are an `Array`.
  */
 export const areString = (...value: any): boolean => check('string', ...value);

packages/type/README.md

@@ -1,13 +1,14 @@
 // Function.
 import { isBoolean } from '../../is/lib/is-boolean.func';
 // Type.
+import { AnyBoolean } from '../../type/any-boolean.type';
 import { GuardBoolean } from '../type/guard-boolean.type';
 import { ResultCallback } from '../../type/result-callback.type';
 /**
- * Guard the `value` to be a `boolean`.
- * @param value A `boolean` type `value` to guard.
- * @param callback Optional `ResultCallback` function to handle result before returns.
- * @returns A `boolean` indicating whether or not the `value` is a `boolean`.
+ * Guard the `value` to be any type of a boolean.
+ * @param value An `AnyBoolean` type `value` to guard.
+ * @param callback An optional `ResultCallback` function to handle result before returns.
+ * @returns A `boolean` indicating whether or not the `value` is a `boolean` type or `Boolean` object.
  */
-export const guardBoolean: GuardBoolean = (value: boolean, callback?: ResultCallback): value is boolean =>
+export const guardBoolean: GuardBoolean = <B extends AnyBoolean>(value: B, callback?: ResultCallback): value is B =>
   isBoolean(value, callback);

packages/type/package-lock.json

@@ -1,13 +1,14 @@
 // Function.
 import { isNumber } from '../../is/lib/is-number.func';
 // Type.
+import { AnyNumber } from '../../type/any-number.type';
 import { GuardNumber } from '../type/guard-number.type';
 import { ResultCallback } from '../../type/result-callback.type';
 /**
- * Guard the `value` to be a `number`.
- * @param value A `number` type `value` to guard.
- * @param callback Optional `ResultCallback` function to handle result before returns.
- * @returns A `boolean` indicating whether or not the `value` is a `number`.
+ * Guard the `value` to be any type of a number.
+ * @param value An `AnyNumber` type `value` to guard.
+ * @param callback An optional `ResultCallback` function to handle result before returns.
+ * @returns A `boolean` indicating whether or not the `value` is a `number` type or `Number` object.
  */
-export const guardNumber: GuardNumber = (value: number, callback?: ResultCallback): value is number =>
+export const guardNumber: GuardNumber = <N extends AnyNumber>(value: N, callback?: ResultCallback): value is N =>
   isNumber(value, callback);

packages/type/package.json

@@ -1,13 +1,14 @@
 // Function.
 import { isString } from '../../is/lib/is-string.func';
 // Type.
+import { AnyString } from '../../type/any-string.type';
 import { GuardString } from '../type/guard-string.type';
 import { ResultCallback } from '../../type/result-callback.type';
 /**
- * Guard the `value` to be a `string`.
- * @param value A `string` type `value` to guard.
- * @param callback Optional `ResultCallback` function to handle result before returns.
- * @returns A `boolean` indicating whether or not the `value` is a `string`.
+ * Guard the `value` to be any type of a string.
+ * @param value An `AnyString` type `value` to guard.
+ * @param callback An Optional `ResultCallback` function to handle result before returns.
+ * @returns A `boolean` indicating whether or not the `value` is a `string` type or `String` object.
  */
-export const guardString: GuardString = (value: string, callback?: ResultCallback): value is string =>
+export const guardString: GuardString = <S extends AnyString>(value: S, callback?: ResultCallback): value is S =>
   isString(value, callback);

packages/type/src/are/lib/are-string.func.ts

@@ -1,7 +1,7 @@
 // Function.
 import { guardBoolean } from '../lib/guard-boolean.func';
 // Variables.
-import { FALSE_EXPECTATION, TRUE, TRUE_EXPECTATION, FALSE } from './variables/boolean.const';
+import { FALSE_EXPECTATION, TRUE, TRUE_EXPECTATION, FALSE, TRUE_INSTANCE, FALSE_INSTANCE } from './variables/boolean.const';
 
 describe(guardBoolean.name, () => {
   // Defined.
@@ -16,14 +16,22 @@ describe(guardBoolean.name, () => {
         return result;
       });
     });
-
     // ... primitives.
     describe(`primitive`, () => {
       // boolean
       describe(`boolean`, () => {
-        it(`${FALSE_EXPECTATION}`, () => expect(guardBoolean(FALSE)).toBe(TRUE));
-        it(`${TRUE_EXPECTATION}`, () => expect(guardBoolean(TRUE)).toBe(TRUE));
+        it(`FALSE`, () => expect(guardBoolean(FALSE)).toBe(TRUE));
+        it(`TRUE`, () => expect(guardBoolean(TRUE)).toBe(TRUE));
+      });
+    });
+    // ... objective.
+    describe(`objective`, () => {
+      // boolean
+      describe(`boolean`, () => {
+        it(`${TRUE_EXPECTATION}`, () => expect(guardBoolean(TRUE_INSTANCE)).toBe(TRUE));
+        it(`${FALSE_EXPECTATION}`, () => expect(guardBoolean(FALSE_INSTANCE)).toBe(TRUE));
       });
     });
+
   });
 });