Merge pull request #4 from angular-package/3.2.x

3.2.x

Author: angularpackage

README.md

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

packages/type/README.md

@@ -1,10 +1,18 @@
+// `guard` object.
 export { guard } from './lib/guard.object';
-
-export { guardArray } from './lib/guard-array.func.type';
+// `guard` prefix functions,
+export { guardArray } from './lib/guard-array.func';
+export { guardBigInt } from './lib/guard-big-int.func';
+export { guardBoolean } from './lib/guard-boolean.func';
 export { guardFunction } from './lib/guard-function.func';
+export { guardInstance } from './lib/guard-instance.func';
+export { guardKey } from './lib/guard-key.func';
 export { guardNumber } from './lib/guard-number.func';
-export { guardObjectKey } from './lib/guard-object-key.func';
+export { guardNull } from './lib/guard-null.func';
 export { guardObject } from './lib/guard-object.func';
+export { guardObjectKey } from './lib/guard-object-key.func';
 export { guardPrimitive } from './lib/guard-primitive.func';
 export { guardString } from './lib/guard-string.func';
+export { guardSymbol } from './lib/guard-symbol.func';
 export { guardType } from './lib/guard-type.func';
+export { guardUndefined } from './lib/guard-undefined.func';

packages/type/package-lock.json

@@ -1,22 +1,33 @@
-
 import { GuardArray } from '../type/guard-array.type';
+import { GuardBigInt } from '../type/guard-big-int.type';
+import { GuardBoolean } from '../type/guard-boolean.type';
 import { GuardFunction } from '../type/guard-function.type';
+import { GuardKey } from '../type/guard-key.type';
 import { GuardNumber } from '../type/guard-number.type';
+import { GuardObject } from '../type/guard-object.type';
 import { GuardObjectKey } from '../type/guard-object-key.type';
 import { GuardPrimitive } from '../type/guard-primitive.type';
 import { GuardString } from '../type/guard-string.type';
 import { GuardType } from '../type/guard-type.type';
-import { GuardObject } from '../type/guard-object.type';
+import { GuardInstance } from '../type/guard-instance.type';
+import { GuardNull } from '../type/guard-null.type';
+import { GuardSymbol } from '../type/guard-symbol.type';
+import { GuardUndefined } from '../type/guard-undefined.type';
 
 export interface GuardIs {
   array: GuardArray;
+  bigint: GuardBigInt;
+  boolean: GuardBoolean;
   function: GuardFunction;
-  // TODO: Guard not
-  // not: GuardNotIs;
+  instance: GuardInstance;
+  key: GuardKey;
+  null: GuardNull;
   number: GuardNumber;
   object: GuardObject;
   objectKey: GuardObjectKey;
   primitive: GuardPrimitive;
   string: GuardString;
+  symbol: GuardSymbol;
   type: GuardType;
+  undefined: GuardUndefined;
 }

packages/type/package.json

@@ -0,0 +1,13 @@
+// Function.
+import { isArray } from '../../is/lib/is-array.func';
+// Type.
+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 Optional `ResultCallback` function to handle 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);

packages/type/src/guard/index.ts

@@ -0,0 +1,13 @@
+// Function.
+import { isBigInt } from '../../is/lib/is-big-int.func';
+// Type.
+import { GuardBigInt } from '../type/guard-big-int.type';
+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.
+ * @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);

packages/type/src/guard/interface/guard-is.interface.ts

@@ -0,0 +1,13 @@
+// Function.
+import { isBoolean } from '../../is/lib/is-boolean.func';
+// 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`.
+ */
+export const guardBoolean: GuardBoolean = (value: boolean, callback?: ResultCallback): value is boolean =>
+  isBoolean(value, callback);