type-fns 0.9.1 → 0.10.0

package/dist/checks/isOfEnum.d.ts

@@ -1,3 +1,9 @@
+type AssessMethod<T extends {
+    [index: string | number | symbol]: string | number;
+}> = (token: string | number | symbol) => token is T[keyof T] & ((token: string | number | symbol) => boolean);
+type AssureMethod<T extends {
+    [index: string | number | symbol]: string | number;
+}> = <I extends string | number | symbol>(input: I) => I & T[keyof T];
 /**
  * a generic fn that allows us to create type checks for enums. for example:
  * ```ts
@@ -11,10 +17,13 @@
  *   }
  *
  *   // define a type check for your enum
- *   const isPlanet = createIsOfEnum(Planet);
+ *   const isPlanet = createIsOfEnum.assess(Planet);
  *
- *   // use your new type check for a type guard
- *   if (!isPlanet(potentialPlanet)) throw new Error('is not a planet');
+ *   // use it to assess type for type guarded blocks
+ *   if (!isPlanet.assess(potentialPlanet)) throw new Error('is not a planet');
+ *
+ *   // use it to assure type for type guarded type casts
+ *   const planet: Planet = isPlanet.assure(potentialPlanet)
  * ```
  *
  * ref: https://stackoverflow.com/a/58278753/3068233
@@ -23,4 +32,8 @@ export declare const createIsOfEnum: <T extends {
     [index: string]: string | number;
     [index: number]: string | number;
     [index: symbol]: string | number;
-}>(e: T) => (token: string | number | symbol) => token is T[keyof T];
+}>(e: T) => {
+    assess: AssessMethod<T>;
+    assure: AssureMethod<T>;
+} & AssessMethod<T>;
+export {};

package/dist/checks/isOfEnum.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createIsOfEnum = void 0;
+const UnexpectedCodePathError_1 = require("../utils/errors/UnexpectedCodePathError");
 /**
  * a generic fn that allows us to create type checks for enums. for example:
  * ```ts
@@ -14,14 +15,30 @@ exports.createIsOfEnum = void 0;
  *   }
  *
  *   // define a type check for your enum
- *   const isPlanet = createIsOfEnum(Planet);
+ *   const isPlanet = createIsOfEnum.assess(Planet);
  *
- *   // use your new type check for a type guard
- *   if (!isPlanet(potentialPlanet)) throw new Error('is not a planet');
+ *   // use it to assess type for type guarded blocks
+ *   if (!isPlanet.assess(potentialPlanet)) throw new Error('is not a planet');
+ *
+ *   // use it to assure type for type guarded type casts
+ *   const planet: Planet = isPlanet.assure(potentialPlanet)
  * ```
  *
  * ref: https://stackoverflow.com/a/58278753/3068233
  */
-const createIsOfEnum = (e) => (token) => Object.values(e).includes(token);
+const createIsOfEnum = (e) => {
+    const assess = (token) => Object.values(e).includes(token);
+    const assure = (input) => assess(input)
+        ? input
+        : (() => {
+            throw new UnexpectedCodePathError_1.UnexpectedCodePathError('is not of DeclaredGoogleAdsCriterionUserInterestTaxonomy');
+        })();
+    const result = function (...input) {
+        return assess(...input);
+    };
+    result.assess = assess;
+    result.assure = assure;
+    return result;
+};
 exports.createIsOfEnum = createIsOfEnum;
 //# sourceMappingURL=isOfEnum.js.map

package/dist/checks/isOfEnum.js.map

@@ -1 +1 @@
-{"version":3,"file":"isOfEnum.js","sourceRoot":"","sources":["../../src/checks/isOfEnum.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AACI,MAAM,cAAc,GACzB,CAAmE,CAAI,EAAE,EAAE,CAC3E,CAAC,KAA+B,EAAuB,EAAE,CACvD,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAmB,CAAC,CAAC;AAHtC,QAAA,cAAc,kBAGwB"}
+{"version":3,"file":"isOfEnum.js","sourceRoot":"","sources":["../../src/checks/isOfEnum.ts"],"names":[],"mappings":";;;AAAA,qFAAkF;AAUlF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACI,MAAM,cAAc,GAAG,CAG5B,CAAI,EAIc,EAAE;IACpB,MAAM,MAAM,GAAG,CAAC,KAA+B,EAAuB,EAAE,CACtE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAmB,CAAC,CAAC;IACjD,MAAM,MAAM,GAAG,CAAqC,KAAQ,EAAE,EAAE,CAC9D,MAAM,CAAC,KAAK,CAAC;QACX,CAAC,CAAC,KAAK;QACP,CAAC,CAAC,CAAC,GAAG,EAAE;YACJ,MAAM,IAAI,iDAAuB,CAC/B,0DAA0D,CAC3D,CAAC;QACJ,CAAC,CAAC,EAAE,CAAC;IACX,MAAM,MAAM,GAAG,UACb,GAAG,KAAgC;QAEnC,OAAO,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC;IAC1B,CAGC,CAAC;IACF,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AA7BW,QAAA,cAAc,kBA6BzB"}

package/dist/checks/isOfEnum.test.js

@@ -2,18 +2,37 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const isOfEnum_1 = require("./isOfEnum");
 describe('isOfEnum', () => {
-    it('can be used for custom enums correctly', () => {
-        let Planet;
-        (function (Planet) {
-            Planet["VENUS"] = "VENUS";
-            Planet["EARTH"] = "EARTH";
-            Planet["MARS"] = "MARS";
-        })(Planet || (Planet = {}));
+    let Planet;
+    (function (Planet) {
+        Planet["VENUS"] = "VENUS";
+        Planet["EARTH"] = "EARTH";
+        Planet["MARS"] = "MARS";
+    })(Planet || (Planet = {}));
+    it('can be used to assess correctly, default call', () => {
         const isPlanet = (0, isOfEnum_1.createIsOfEnum)(Planet);
         const earthIsPlanet = isPlanet('EARTH');
         const plutoIsPlanet = isPlanet('PLUTO');
         expect(earthIsPlanet).toEqual(true);
         expect(plutoIsPlanet).toEqual(false);
     });
+    it('can be used to assess correctly, named call', () => {
+        const isPlanet = (0, isOfEnum_1.createIsOfEnum)(Planet);
+        const earthIsPlanet = isPlanet.assess('EARTH');
+        const plutoIsPlanet = isPlanet.assess('PLUTO');
+        expect(earthIsPlanet).toEqual(true);
+        expect(plutoIsPlanet).toEqual(false);
+    });
+    it('can be used to create type guarded branches', () => {
+        const isPlanet = (0, isOfEnum_1.createIsOfEnum)(Planet);
+        const earth = 'EARTH';
+        if (isPlanet.assess(earth)) {
+            const home = earth; // no type error
+        }
+    });
+    it('can be used to create type asserted casts', () => {
+        const isPlanet = (0, isOfEnum_1.createIsOfEnum)(Planet);
+        const earth = 'EARTH';
+        const home = isPlanet.assure(earth);
+    });
 });
 //# sourceMappingURL=isOfEnum.test.js.map

package/dist/checks/isOfEnum.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"isOfEnum.test.js","sourceRoot":"","sources":["../../src/checks/isOfEnum.test.ts"],"names":[],"mappings":";;AAAA,yCAA4C;AAE5C,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;IACxB,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;QAChD,IAAK,MAIJ;QAJD,WAAK,MAAM;YACT,yBAAe,CAAA;YACf,yBAAe,CAAA;YACf,uBAAa,CAAA;QACf,CAAC,EAJI,MAAM,KAAN,MAAM,QAIV;QACD,MAAM,QAAQ,GAAG,IAAA,yBAAc,EAAC,MAAM,CAAC,CAAC;QACxC,MAAM,aAAa,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC;QACxC,MAAM,aAAa,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC;QACxC,MAAM,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACpC,MAAM,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
+{"version":3,"file":"isOfEnum.test.js","sourceRoot":"","sources":["../../src/checks/isOfEnum.test.ts"],"names":[],"mappings":";;AAAA,yCAA4C;AAE5C,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;IACxB,IAAK,MAIJ;IAJD,WAAK,MAAM;QACT,yBAAe,CAAA;QACf,yBAAe,CAAA;QACf,uBAAa,CAAA;IACf,CAAC,EAJI,MAAM,KAAN,MAAM,QAIV;IACD,EAAE,CAAC,+CAA+C,EAAE,GAAG,EAAE;QACvD,MAAM,QAAQ,GAAG,IAAA,yBAAc,EAAC,MAAM,CAAC,CAAC;QACxC,MAAM,aAAa,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC;QACxC,MAAM,aAAa,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC;QACxC,MAAM,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACpC,MAAM,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;QACrD,MAAM,QAAQ,GAAG,IAAA,yBAAc,EAAC,MAAM,CAAC,CAAC;QACxC,MAAM,aAAa,GAAG,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC/C,MAAM,aAAa,GAAG,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC/C,MAAM,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACpC,MAAM,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;QACrD,MAAM,QAAQ,GAAG,IAAA,yBAAc,EAAC,MAAM,CAAC,CAAC;QACxC,MAAM,KAAK,GAAG,OAAO,CAAC;QACtB,IAAI,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE;YAC1B,MAAM,IAAI,GAAW,KAAK,CAAC,CAAC,gBAAgB;SAC7C;IACH,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACnD,MAAM,QAAQ,GAAG,IAAA,yBAAc,EAAC,MAAM,CAAC,CAAC;QACxC,MAAM,KAAK,GAAG,OAAO,CAAC;QACtB,MAAM,IAAI,GAAW,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/companions/omit.d.ts

@@ -1,4 +1,4 @@
 /**
  * a companion to the `Omit` type, returns a new object without the omitted attributes
  */
-export declare const omit: <T extends Record<string, any>>(obj: T, keys: (keyof T)[]) => Omit<T, keyof T>;
+export declare const omit: <T extends Record<string, any>, K extends readonly (keyof T)[]>(obj: T, keys: K) => Omit<T, K[number]>;

package/dist/companions/omit.js.map

@@ -1 +1 @@
-{"version":3,"file":"omit.js","sourceRoot":"","sources":["../../src/companions/omit.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACI,MAAM,IAAI,GAAG,CAClB,GAAM,EACN,IAAiB,EACa,EAAE,CAChC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;IACnD,iEAAiE;IACjE,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,OAAO,CAAC;IAEvC,6CAA6C;IAC7C,uCAAY,OAAO,KAAE,CAAC,GAAG,CAAC,EAAE,KAAK,IAAG;AACtC,CAAC,EAAE,EAAyB,CAAQ,CAAC;AAV1B,QAAA,IAAI,QAUsB"}
+{"version":3,"file":"omit.js","sourceRoot":"","sources":["../../src/companions/omit.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACI,MAAM,IAAI,GAAG,CAIlB,GAAM,EACN,IAAO,EACa,EAAE,CACtB,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;IACnD,iEAAiE;IACjE,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,OAAO,CAAC;IAEvC,6CAA6C;IAC7C,uCAAY,OAAO,KAAE,CAAC,GAAG,CAAC,EAAE,KAAK,IAAG;AACtC,CAAC,EAAE,EAAyB,CAAQ,CAAC;AAb1B,QAAA,IAAI,QAasB"}

package/dist/companions/omit.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/companions/omit.test.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const omit_1 = require("./omit");
+describe('omit', () => {
+    it('should satisfy the standard Omit type', () => {
+        const withKey = { a: 1, b: 2 };
+        const omitKeyTypeFound = (0, omit_1.omit)(withKey, ['a']);
+        const omitKeyTypeCheck = omitKeyTypeFound;
+    });
+});
+//# sourceMappingURL=omit.test.js.map

package/dist/companions/omit.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"omit.test.js","sourceRoot":"","sources":["../../src/companions/omit.test.ts"],"names":[],"mappings":";;AAAA,iCAA8B;AAE9B,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE;IACpB,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAC/C,MAAM,OAAO,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;QAE/B,MAAM,gBAAgB,GAAG,IAAA,WAAI,EAAC,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;QAC9C,MAAM,gBAAgB,GAA8B,gBAAgB,CAAC;IACvE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/companions/pick.d.ts

@@ -1,4 +1,4 @@
 /**
  * a companion to the `Pick` type, returns a new object with only the picked attributes
  */
-export declare const pick: <T extends Record<string, any>>(obj: T, keys: (keyof T)[]) => Pick<T, keyof T>;
+export declare const pick: <T extends Record<string, any>, K extends readonly (keyof T)[]>(obj: T, keys: K) => Pick<T, K[number]>;

package/dist/companions/pick.js.map

@@ -1 +1 @@
-{"version":3,"file":"pick.js","sourceRoot":"","sources":["../../src/companions/pick.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACI,MAAM,IAAI,GAAG,CAClB,GAAM,EACN,IAAiB,EACa,EAAE,CAChC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;IACnD,qEAAqE;IACrE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,OAAO,CAAC;IAExC,yCAAyC;IACzC,uCAAY,OAAO,KAAE,CAAC,GAAG,CAAC,EAAE,KAAK,IAAG;AACtC,CAAC,EAAE,EAAyB,CAAQ,CAAC;AAV1B,QAAA,IAAI,QAUsB"}
+{"version":3,"file":"pick.js","sourceRoot":"","sources":["../../src/companions/pick.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACI,MAAM,IAAI,GAAG,CAIlB,GAAM,EACN,IAAO,EACa,EAAE,CACtB,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;IACnD,qEAAqE;IACrE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,OAAO,CAAC;IAExC,yCAAyC;IACzC,uCAAY,OAAO,KAAE,CAAC,GAAG,CAAC,EAAE,KAAK,IAAG;AACtC,CAAC,EAAE,EAAyB,CAAQ,CAAC;AAb1B,QAAA,IAAI,QAasB"}

package/dist/companions/pick.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/companions/pick.test.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const pick_1 = require("./pick");
+describe('pick', () => {
+    it('should satisfy the standard Pick type', () => {
+        const withAll = { a: 1, b: 2 };
+        const pickKeyTypeFound = (0, pick_1.pick)(withAll, ['a']);
+        const pickKeyTypeCheck = pickKeyTypeFound;
+    });
+});
+//# sourceMappingURL=pick.test.js.map

package/dist/companions/pick.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pick.test.js","sourceRoot":"","sources":["../../src/companions/pick.test.ts"],"names":[],"mappings":";;AAAA,iCAA8B;AAE9B,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE;IACpB,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAC/C,MAAM,OAAO,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;QAE/B,MAAM,gBAAgB,GAAG,IAAA,WAAI,EAAC,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;QAC9C,MAAM,gBAAgB,GAA8B,gBAAgB,CAAC;IACvE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -2,7 +2,7 @@
   "name": "type-fns",
   "author": "ehmpathy",
   "description": "A set of types, type checks, and type guards for simpler, safer, and easier to read code.",
-  "version": "0.9.1",
+  "version": "0.10.0",
   "repository": "ehmpathy/type-fns",
   "homepage": "https://github.com/ehmpathy/type-fns",
   "keywords": [