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

4.1.1

Author: angularpackage

README.md

@@ -1,10 +1,13 @@
 {
   "name": "@angular-package/type",
-  "version": "4.1.0",
+  "version": "4.1.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",
   "peerDependencies": {},
+  "devDependencies": {
+    "tslint": "^6.1.3"
+  },
   "dependencies": {
     "tslib": "^2.1.0"
   },

package-lock.json

@@ -5,11 +5,12 @@ import { Constructor } from '../../type/constructor.type';
 import { GuardInstance } from '../type/guard-instance.type';
 import { ResultCallback } from '../../type/result-callback.type';
 /**
- * Guard the `value` to guard the `value` to be an `object` of a generic `Obj` type equal to an `instance`.
- * @param value An `Obj` type `value` to compare with the `instance`.
- * @param instance A generic `Obj` `Constructor` type to create an `instance` to compare with the `value`.
- * @param callback Optional `ResultCallback` function to handle result before returns.
- * @returns A `boolean` indicating whether or not the `value` is a `symbol`.
+ * 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 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`.
  */
-export const guardInstance: GuardInstance = <Obj extends object>(value: Obj, instance: Constructor<Obj>, callback?: ResultCallback): value is Obj =>
-  isInstance<Obj>(value, instance, callback);
+export const guardInstance: GuardInstance =
+  <Obj extends object>(value: Obj, constructor: Constructor<Obj>, callback?: ResultCallback): value is Obj =>
+    isInstance<Obj>(value, constructor, callback);

package.json

@@ -1,6 +1,6 @@
 // Function.
 import { guardArray } from '../lib/guard-array.func';
-// Variables.
+// Constant.
 import {
   ARRAY_BIGINT,
   ARRAY_BOOLEAN,

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

@@ -1,6 +1,6 @@
 // Function.
 import { guardBigInt } from '../lib/guard-big-int.func';
-// Variables.
+// Constant.
 import { BIGINT, BIGINT_EXPECTATION, BIGINT_INSTANCE } from '../../testing/variables/strict/big-int.const';
 import { TRUE } from '../../testing/variables/strict/boolean.const';
 

src/guard/test/guard-array.spec.ts

@@ -1,6 +1,6 @@
 // Function.
 import { guardBoolean } from '../lib/guard-boolean.func';
-// Variables.
+// Constant.
 import { FALSE_EXPECTATION, TRUE, TRUE_EXPECTATION, FALSE, TRUE_INSTANCE, FALSE_INSTANCE } from '../../testing/variables/strict/boolean.const';
 
 describe(guardBoolean.name, () => {

src/guard/test/guard-bigint.spec.ts

@@ -2,13 +2,15 @@
 import { guard } from '../lib/guard.object';
 // Function.
 import { guardClass } from '../lib/guard-class.func';
-// Variables.
-import { Person } from '../../testing/variables/strict/class.const';
+// Constant.
+import { Persons } from '../../testing/variables/strict/class.const';
 import { TRUE } from '../../testing/variables/strict/boolean.const';
 
 describe(guardClass.name, () => {
   // TRUE
   it('is DEFINED', () => expect(guardClass).toBeDefined());
-  it(`Class`, () => expect(guardClass(Person)).toBe(TRUE));
-  it(`Class`, () => expect(guard.is.class(Person)).toBe(TRUE));
+  it(`Class`, () => {
+    expect(guardClass(Persons)).toBe(TRUE);
+    expect(guard.is.class(Persons)).toBe(TRUE);
+  });
 });

src/guard/test/guard-boolean.spec.ts

@@ -1,6 +1,6 @@
 // Function.
 import { guardDefined } from '../lib/guard-defined.func';
-// Variables.
+// Constant.
 import { STRING } from '../../testing/variables/strict/string.const';
 import { TRUE } from '../../testing/variables/strict/boolean.const';
 

src/guard/test/guard-class.spec.ts

@@ -1,6 +1,6 @@
 // Function.
 import { guardFunction } from '../lib/guard-function.func';
-// Variables.
+// Constant.
 import { FUNCTION } from '../../testing/variables/function.const';
 
 describe(guardFunction.name, () => {