Merge pull request #13 from angular-package/4.0.x

4.0.0

Author: angularpackage

README.md

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

packages/type/README.md

@@ -4,6 +4,8 @@ export { guard } from './lib/guard.object';
 export { guardArray } from './lib/guard-array.func';
 export { guardBigInt } from './lib/guard-big-int.func';
 export { guardBoolean } from './lib/guard-boolean.func';
+export { guardClass } from './lib/guard-class.func';
+export { guardDefined } from './lib/guard-defined.func';
 export { guardFunction } from './lib/guard-function.func';
 export { guardInstance } from './lib/guard-instance.func';
 export { guardKey } from './lib/guard-key.func';

packages/type/package-lock.json

@@ -1,6 +1,8 @@
 import { GuardArray } from '../type/guard-array.type';
 import { GuardBigInt } from '../type/guard-big-int.type';
 import { GuardBoolean } from '../type/guard-boolean.type';
+import { GuardClass } from '../type/guard-class.type';
+import { GuardDefined } from '../type/guard-defined.type';
 import { GuardFunction } from '../type/guard-function.type';
 import { GuardKey } from '../type/guard-key.type';
 import { GuardNumber } from '../type/guard-number.type';
@@ -18,6 +20,8 @@ export interface GuardIs {
   array: GuardArray;
   bigint: GuardBigInt;
   boolean: GuardBoolean;
+  class: GuardClass;
+  defined: GuardDefined;
   function: GuardFunction;
   instance: GuardInstance;
   key: GuardKey;

packages/type/package.json

@@ -0,0 +1,13 @@
+// Function.
+import { isClass } from '../../is/lib/is-class.func';
+// Type.
+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 `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 generic `class`.
+ */
+export const guardClass: GuardClass = <Class>(value: Class, callback?: ResultCallback): value is Class =>
+  isClass<Class>(value, callback);

packages/type/src/guard/index.ts

@@ -0,0 +1,14 @@
+// Function.
+import { isDefined } from '../../is/lib/is-defined.func';
+// Type.
+import { Defined } from '../../type/defined.type';
+import { GuardDefined } from '../type/guard-defined.type';
+import { ResultCallback } from '../../type/result-callback.type';
+/**
+ * Guard the `value` to be defined.
+ * @param value A generic 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 defined, if `undefined` then returns `never`.
+ */
+export const guardDefined: GuardDefined = <Type>(value: Type, callback?: ResultCallback): value is Defined<Type> =>
+  isDefined(value, callback);

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

@@ -2,6 +2,8 @@
 import { guardArray } from './guard-array.func';
 import { guardBigInt } from './guard-big-int.func';
 import { guardBoolean } from './guard-boolean.func';
+import { guardClass } from './guard-class.func';
+import { guardDefined } from './guard-defined.func';
 import { guardFunction } from './guard-function.func';
 import { guardInstance } from './guard-instance.func';
 import { guardKey } from './guard-key.func';
@@ -21,6 +23,8 @@ export const guardIs: GuardIs = {
   array: guardArray,
   bigint: guardBigInt,
   boolean: guardBoolean,
+  class: guardClass,
+  defined: guardDefined,
   function: guardFunction,
   instance: guardInstance,
   key: guardKey,

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

@@ -1,13 +1,15 @@
 // Function.
-import { guardObject } from './guard-object.func';
-import { isKey } from '../../is/lib/is-key.func';
+import { isObjectKey } from '../../is/lib/is-object-key.func';
 // Type.
 import { GuardObjectKey } from '../type/guard-object-key.type';
+import { Key } from '../../type/key.type';
+import { ResultCallback } from '../../type/result-callback.type';
 /**
  * Guard the `value` to be an `object` of a generic `Obj` type that contains the `key` property of the `Key` type.
  * @param value A generic `Obj` type `value` that contains the `key` to guard.
- * @param key A `Key` type name of the property that the `value` contains.
+ * @param key A `Key` or `Key[]` type name of the property that the `value` contains.
+ * @param callback An optional `ResultCallback` function to handle 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, Key extends keyof Obj>(value: Obj, key: Key): value is Obj =>
-  guardObject<Obj>(value) ? isKey(key) ? key in value : true : false;
+export const guardObjectKey: GuardObjectKey = <Obj extends object>(value: Obj, key: Key | Key[], callback?: ResultCallback): value is Obj =>
+  isObjectKey<Obj>(value, key, callback);