type-fns 1.20.2 → 1.21.0

package/dist/guards/assure.d.ts

@@ -0,0 +1,16 @@
+import { AssessIsOfTypeMethod } from '../wrappers/withAssure';
+/**
+ * what: a standalone assure function that takes a value and a type.check, returning the value if it passes or throwing if it doesn't
+ * why:
+ * - enables inline type narrowing with runtime validation in a single expression
+ * - useful when you want to assure a value satisfies a type guard without pre-wrapping the guard with `asAssure` or `withAssure`
+ *
+ * example:
+ * ```ts
+ * const uuid: Uuid = assure('821e33d6-a330-425d-a393-f97e39113046', isUuid); // passes
+ * const uuid: Uuid = assure('not a uuid', isUuid); // throws AssureIsOfTypeRejectionError
+ * ```
+ */
+export declare const assure: <I, C extends I>(input: I, check: AssessIsOfTypeMethod<I, C>, options?: {
+    name: string;
+}) => C;

package/dist/guards/assure.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assure = void 0;
+const withAssure_1 = require("../wrappers/withAssure");
+/**
+ * what: a standalone assure function that takes a value and a type.check, returning the value if it passes or throwing if it doesn't
+ * why:
+ * - enables inline type narrowing with runtime validation in a single expression
+ * - useful when you want to assure a value satisfies a type guard without pre-wrapping the guard with `asAssure` or `withAssure`
+ *
+ * example:
+ * ```ts
+ * const uuid: Uuid = assure('821e33d6-a330-425d-a393-f97e39113046', isUuid); // passes
+ * const uuid: Uuid = assure('not a uuid', isUuid); // throws AssureIsOfTypeRejectionError
+ * ```
+ */
+const assure = (input, check, options) => {
+    const name = options?.name ?? check.name;
+    if (check(input))
+        return input;
+    throw new withAssure_1.AssureIsOfTypeRejectionError(`assure.rejection: input does not satisfy type.check '${name}'`, {
+        check: name,
+        input: input === undefined ? 'undefined' : input,
+    });
+};
+exports.assure = assure;
+//# sourceMappingURL=assure.js.map

package/dist/guards/assure.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assure.js","sourceRoot":"","sources":["../../src/guards/assure.ts"],"names":[],"mappings":";;;AAAA,uDAGgC;AAEhC;;;;;;;;;;;GAWG;AACI,MAAM,MAAM,GAAG,CACpB,KAAQ,EACR,KAAiC,EACjC,OAA0B,EACvB,EAAE;IACL,MAAM,IAAI,GAAG,OAAO,EAAE,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC;IACzC,IAAI,KAAK,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAC/B,MAAM,IAAI,yCAA4B,CACpC,wDAAwD,IAAI,GAAG,EAC/D;QACE,KAAK,EAAE,IAAI;QACX,KAAK,EAAE,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,KAAK;KACjD,CACF,CAAC;AACJ,CAAC,CAAC;AAdW,QAAA,MAAM,UAcjB"}

package/dist/guards/assure.test.d.ts

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

package/dist/guards/assure.test.js

@@ -0,0 +1,131 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const test_fns_1 = require("test-fns");
+const withAssure_1 = require("../wrappers/withAssure");
+const assure_1 = require("./assure");
+describe('assure', () => {
+    // example type guards for testing
+    const isString = (input) => typeof input === 'string';
+    const isNumber = (input) => typeof input === 'number';
+    const isPositive = (input) => input > 0;
+    const isNonEmptyString = (input) => input.length > 0;
+    describe('happy path', () => {
+        it('should return the value when it satisfies a string check', () => {
+            const result = (0, assure_1.assure)('hello', isString);
+            expect(result).toEqual('hello');
+        });
+        it('should return the value when it satisfies a number check', () => {
+            const result = (0, assure_1.assure)(42, isNumber);
+            expect(result).toEqual(42);
+        });
+        it('should return the value when it satisfies a narrowing check on already-typed input', () => {
+            const result = (0, assure_1.assure)(5, isPositive);
+            expect(result).toEqual(5);
+        });
+    });
+    describe('rejection boundaries', () => {
+        it('should throw when string check receives a number', () => {
+            const error = (0, test_fns_1.getError)(() => (0, assure_1.assure)(123, isString));
+            expect(error).toBeInstanceOf(withAssure_1.AssureIsOfTypeRejectionError);
+            expect(error.message).toContain("input does not satisfy type.check 'isString'");
+        });
+        it('should throw when number check receives a string', () => {
+            const error = (0, test_fns_1.getError)(() => (0, assure_1.assure)('not a number', isNumber));
+            expect(error).toBeInstanceOf(withAssure_1.AssureIsOfTypeRejectionError);
+            expect(error.message).toContain("input does not satisfy type.check 'isNumber'");
+        });
+        it('should throw when positive check receives zero', () => {
+            const error = (0, test_fns_1.getError)(() => (0, assure_1.assure)(0, isPositive));
+            expect(error).toBeInstanceOf(withAssure_1.AssureIsOfTypeRejectionError);
+            expect(error.message).toContain("input does not satisfy type.check 'isPositive'");
+        });
+        it('should throw when positive check receives a negative number', () => {
+            const error = (0, test_fns_1.getError)(() => (0, assure_1.assure)(-1, isPositive));
+            expect(error).toBeInstanceOf(withAssure_1.AssureIsOfTypeRejectionError);
+            expect(error.message).toContain("input does not satisfy type.check 'isPositive'");
+        });
+        it('should throw when non-empty string check receives an empty string', () => {
+            const error = (0, test_fns_1.getError)(() => (0, assure_1.assure)('', isNonEmptyString));
+            expect(error).toBeInstanceOf(withAssure_1.AssureIsOfTypeRejectionError);
+            expect(error.message).toContain("input does not satisfy type.check 'isNonEmptyString'");
+        });
+    });
+    describe('edge cases', () => {
+        it('should handle null input', () => {
+            const error = (0, test_fns_1.getError)(() => (0, assure_1.assure)(null, isString));
+            expect(error).toBeInstanceOf(withAssure_1.AssureIsOfTypeRejectionError);
+            expect(error.message).toContain("input does not satisfy type.check 'isString'");
+        });
+        it('should handle undefined input and include it in error context', () => {
+            const error = (0, test_fns_1.getError)(() => (0, assure_1.assure)(undefined, isString));
+            expect(error).toBeInstanceOf(withAssure_1.AssureIsOfTypeRejectionError);
+            expect(error.message).toContain("input does not satisfy type.check 'isString'");
+        });
+        it('should handle falsy values that pass the check', () => {
+            const result = (0, assure_1.assure)(0, isNumber);
+            expect(result).toEqual(0);
+        });
+        it('should handle empty string that passes a string check', () => {
+            const result = (0, assure_1.assure)('', isString);
+            expect(result).toEqual('');
+        });
+    });
+    describe('custom name option', () => {
+        it('should use custom name in error message when provided', () => {
+            const error = (0, test_fns_1.getError)(() => (0, assure_1.assure)('test', isNumber, { name: 'customNumberCheck' }));
+            expect(error.message).toContain("input does not satisfy type.check 'customNumberCheck'");
+        });
+        it('should use function name when custom name is not provided', () => {
+            const error = (0, test_fns_1.getError)(() => (0, assure_1.assure)('test', isNumber));
+            expect(error.message).toContain("input does not satisfy type.check 'isNumber'");
+        });
+        it('should handle anonymous functions gracefully', () => {
+            const error = (0, test_fns_1.getError)(() => (0, assure_1.assure)('test', (input) => typeof input === 'number'));
+            expect(error).toBeInstanceOf(withAssure_1.AssureIsOfTypeRejectionError);
+        });
+    });
+    describe('type narrowing', () => {
+        it('should narrow union types', () => {
+            const input = 'hello';
+            const result = (0, assure_1.assure)(input, isString); // narrows to string
+            // @ts-expect-error - result is string, not number
+            const badResult = (0, assure_1.assure)(input, isString);
+            expect(result).toBeDefined();
+            expect(badResult).toBeDefined();
+        });
+        it('should narrow unknown to specific type', () => {
+            const input = 42;
+            const result = (0, assure_1.assure)(input, isNumber); // narrows to number
+            // @ts-expect-error - result is number, not string
+            const badResult = (0, assure_1.assure)(input, isNumber);
+            expect(result).toBeDefined();
+            expect(badResult).toBeDefined();
+        });
+        it('should work with branded types', () => {
+            const isUserId = (input) => input.startsWith('user_');
+            const result = (0, assure_1.assure)('user_123', isUserId); // narrows to UserId
+            // @ts-expect-error - result is UserId, not number
+            const badResult = (0, assure_1.assure)('user_123', isUserId);
+            expect(result).toBeDefined();
+            expect(badResult).toBeDefined();
+            const error = (0, test_fns_1.getError)(() => (0, assure_1.assure)('invalid', isUserId));
+            expect(error).toBeInstanceOf(withAssure_1.AssureIsOfTypeRejectionError);
+        });
+        it('should work with enum checks', () => {
+            let Status;
+            (function (Status) {
+                Status["ACTIVE"] = "ACTIVE";
+                Status["INACTIVE"] = "INACTIVE";
+            })(Status || (Status = {}));
+            const isStatus = (input) => Object.values(Status).includes(input);
+            const result = (0, assure_1.assure)('ACTIVE', isStatus); // narrows to Status
+            // @ts-expect-error - result is Status, not number
+            const badResult = (0, assure_1.assure)('ACTIVE', isStatus);
+            expect(result).toBeDefined();
+            expect(badResult).toBeDefined();
+            const error = (0, test_fns_1.getError)(() => (0, assure_1.assure)('INVALID', isStatus));
+            expect(error).toBeInstanceOf(withAssure_1.AssureIsOfTypeRejectionError);
+        });
+    });
+});
+//# sourceMappingURL=assure.test.js.map

package/dist/guards/assure.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assure.test.js","sourceRoot":"","sources":["../../src/guards/assure.test.ts"],"names":[],"mappings":";;AAAA,uCAAoC;AAEpC,uDAAsE;AACtE,qCAAkC;AAElC,QAAQ,CAAC,QAAQ,EAAE,GAAG,EAAE;IACtB,kCAAkC;IAClC,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAmB,EAAE,CACnD,OAAO,KAAK,KAAK,QAAQ,CAAC;IAC5B,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAmB,EAAE,CACnD,OAAO,KAAK,KAAK,QAAQ,CAAC;IAC5B,MAAM,UAAU,GAAG,CAAC,KAAa,EAAmB,EAAE,CAAC,KAAK,GAAG,CAAC,CAAC;IACjE,MAAM,gBAAgB,GAAG,CAAC,KAAa,EAAmB,EAAE,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;IAE9E,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;QAC1B,EAAE,CAAC,0DAA0D,EAAE,GAAG,EAAE;YAClE,MAAM,MAAM,GAAW,IAAA,eAAM,EAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;YACjD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0DAA0D,EAAE,GAAG,EAAE;YAClE,MAAM,MAAM,GAAW,IAAA,eAAM,EAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;YAC5C,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oFAAoF,EAAE,GAAG,EAAE;YAC5F,MAAM,MAAM,GAAW,IAAA,eAAM,EAAC,CAAC,EAAE,UAAU,CAAC,CAAC;YAC7C,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;QACpC,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;YAC1D,MAAM,KAAK,GAAG,IAAA,mBAAQ,EAAC,GAAG,EAAE,CAAC,IAAA,eAAM,EAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC;YACpD,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,yCAA4B,CAAC,CAAC;YAC3D,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,SAAS,CAC7B,8CAA8C,CAC/C,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;YAC1D,MAAM,KAAK,GAAG,IAAA,mBAAQ,EAAC,GAAG,EAAE,CAAC,IAAA,eAAM,EAAC,cAAc,EAAE,QAAQ,CAAC,CAAC,CAAC;YAC/D,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,yCAA4B,CAAC,CAAC;YAC3D,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,SAAS,CAC7B,8CAA8C,CAC/C,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;YACxD,MAAM,KAAK,GAAG,IAAA,mBAAQ,EAAC,GAAG,EAAE,CAAC,IAAA,eAAM,EAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC;YACpD,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,yCAA4B,CAAC,CAAC;YAC3D,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,SAAS,CAC7B,gDAAgD,CACjD,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6DAA6D,EAAE,GAAG,EAAE;YACrE,MAAM,KAAK,GAAG,IAAA,mBAAQ,EAAC,GAAG,EAAE,CAAC,IAAA,eAAM,EAAC,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC;YACrD,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,yCAA4B,CAAC,CAAC;YAC3D,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,SAAS,CAC7B,gDAAgD,CACjD,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mEAAmE,EAAE,GAAG,EAAE;YAC3E,MAAM,KAAK,GAAG,IAAA,mBAAQ,EAAC,GAAG,EAAE,CAAC,IAAA,eAAM,EAAC,EAAE,EAAE,gBAAgB,CAAC,CAAC,CAAC;YAC3D,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,yCAA4B,CAAC,CAAC;YAC3D,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,SAAS,CAC7B,sDAAsD,CACvD,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;QAC1B,EAAE,CAAC,0BAA0B,EAAE,GAAG,EAAE;YAClC,MAAM,KAAK,GAAG,IAAA,mBAAQ,EAAC,GAAG,EAAE,CAAC,IAAA,eAAM,EAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC;YACrD,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,yCAA4B,CAAC,CAAC;YAC3D,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,SAAS,CAC7B,8CAA8C,CAC/C,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,+DAA+D,EAAE,GAAG,EAAE;YACvE,MAAM,KAAK,GAAG,IAAA,mBAAQ,EAAC,GAAG,EAAE,CAAC,IAAA,eAAM,EAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC;YAC1D,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,yCAA4B,CAAC,CAAC;YAC3D,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,SAAS,CAC7B,8CAA8C,CAC/C,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;YACxD,MAAM,MAAM,GAAW,IAAA,eAAM,EAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;YAC3C,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uDAAuD,EAAE,GAAG,EAAE;YAC/D,MAAM,MAAM,GAAW,IAAA,eAAM,EAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;YAC5C,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAClC,EAAE,CAAC,uDAAuD,EAAE,GAAG,EAAE;YAC/D,MAAM,KAAK,GAAG,IAAA,mBAAQ,EAAC,GAAG,EAAE,CAC1B,IAAA,eAAM,EAAC,MAAM,EAAE,QAAQ,EAAE,EAAE,IAAI,EAAE,mBAAmB,EAAE,CAAC,CACxD,CAAC;YACF,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,SAAS,CAC7B,uDAAuD,CACxD,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;YACnE,MAAM,KAAK,GAAG,IAAA,mBAAQ,EAAC,GAAG,EAAE,CAAC,IAAA,eAAM,EAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;YACvD,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,SAAS,CAC7B,8CAA8C,CAC/C,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;YACtD,MAAM,KAAK,GAAG,IAAA,mBAAQ,EAAC,GAAG,EAAE,CAC1B,IAAA,eAAM,EACJ,MAAM,EACN,CAAC,KAAc,EAAmB,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,CAC/D,CACF,CAAC;YACF,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,yCAA4B,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAC9B,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;YACnC,MAAM,KAAK,GAAoB,OAAO,CAAC;YACvC,MAAM,MAAM,GAAW,IAAA,eAAM,EAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,oBAAoB;YACpE,kDAAkD;YAClD,MAAM,SAAS,GAAW,IAAA,eAAM,EAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;YAClD,MAAM,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;YAC7B,MAAM,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,CAAC;QAClC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;YAChD,MAAM,KAAK,GAAY,EAAE,CAAC;YAC1B,MAAM,MAAM,GAAW,IAAA,eAAM,EAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,oBAAoB;YACpE,kDAAkD;YAClD,MAAM,SAAS,GAAW,IAAA,eAAM,EAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;YAClD,MAAM,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;YAC7B,MAAM,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,CAAC;QAClC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;YAExC,MAAM,QAAQ,GAAG,CAAC,KAAa,EAAmB,EAAE,CAClD,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;YAE5B,MAAM,MAAM,GAAW,IAAA,eAAM,EAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC,oBAAoB;YACzE,kDAAkD;YAClD,MAAM,SAAS,GAAW,IAAA,eAAM,EAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;YACvD,MAAM,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;YAC7B,MAAM,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,CAAC;YAEhC,MAAM,KAAK,GAAG,IAAA,mBAAQ,EAAC,GAAG,EAAE,CAAC,IAAA,eAAM,EAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC;YAC1D,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,yCAA4B,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;YACtC,IAAK,MAGJ;YAHD,WAAK,MAAM;gBACT,2BAAiB,CAAA;gBACjB,+BAAqB,CAAA;YACvB,CAAC,EAHI,MAAM,KAAN,MAAM,QAGV;YACD,MAAM,QAAQ,GAAG,CAAC,KAAa,EAAmB,EAAE,CAClD,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,KAAe,CAAC,CAAC;YAElD,MAAM,MAAM,GAAW,IAAA,eAAM,EAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,oBAAoB;YACvE,kDAAkD;YAClD,MAAM,SAAS,GAAW,IAAA,eAAM,EAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;YACrD,MAAM,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;YAC7B,MAAM,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,CAAC;YAEhC,MAAM,KAAK,GAAG,IAAA,mBAAQ,EAAC,GAAG,EAAE,CAAC,IAAA,eAAM,EAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC;YAC1D,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,yCAA4B,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/index.d.ts

@@ -18,3 +18,4 @@ export * from './wrappers/withAssure';
 export * from './checks/isKeyOf';
 export * from './types/PickAny';
 export * from './types/Empty';
+export * from './guards/assure';

package/dist/index.js

@@ -34,4 +34,5 @@ __exportStar(require("./wrappers/withAssure"), exports);
 __exportStar(require("./checks/isKeyOf"), exports);
 __exportStar(require("./types/PickAny"), exports);
 __exportStar(require("./types/Empty"), exports);
+__exportStar(require("./guards/assure"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iDAA+B;AAC/B,mDAAiC;AACjC,uDAAqC;AACrC,qDAAmC;AACnC,oDAAkC;AAClC,qDAAmC;AACnC,uDAAqC;AACrC,sDAAoC;AACpC,kDAAgC;AAChC,qDAAmC;AACnC,0DAAwC;AACxC,wDAAsC;AACtC,oDAAkC;AAClC,oDAAkC;AAClC,oDAAkC;AAClC,qDAAmC;AACnC,wDAAsC;AACtC,mDAAiC;AACjC,kDAAgC;AAChC,gDAA8B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iDAA+B;AAC/B,mDAAiC;AACjC,uDAAqC;AACrC,qDAAmC;AACnC,oDAAkC;AAClC,qDAAmC;AACnC,uDAAqC;AACrC,sDAAoC;AACpC,kDAAgC;AAChC,qDAAmC;AACnC,0DAAwC;AACxC,wDAAsC;AACtC,oDAAkC;AAClC,oDAAkC;AAClC,oDAAkC;AAClC,qDAAmC;AACnC,wDAAsC;AACtC,mDAAiC;AACjC,kDAAgC;AAChC,gDAA8B;AAC9B,kDAAgC"}

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": "1.20.2",
+  "version": "1.21.0",
   "repository": "ehmpathy/type-fns",
   "homepage": "https://github.com/ehmpathy/type-fns",
   "keywords": [

package/readme.md

@@ -182,3 +182,28 @@ const superCoolApi = async ({
     : getConfig; // otherwise, it is the config object already
 }
 ```
+
+### `assure`
+
+The `assure` function takes a value and a type check, returns the value narrowed to the checked type if it passes, or throws an error if it doesn't.
+
+This is useful to narrow types inline with runtime validation in a single expression, without needing to wrap your type checks with `withAssure` first.
+
+```ts
+import { assure } from 'type-fns';
+
+// define or import a type check
+type Uuid = string & { __brand: 'Uuid' };
+const isUuid = (value: string): value is Uuid =>
+  /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i.test(value);
+
+// use assure to narrow and validate in one expression
+const uuid: Uuid = assure('821e33d6-a330-425d-a393-f97e39113046', isUuid); // returns the value as Uuid
+const bad: Uuid = assure('not-a-uuid', isUuid); // throws AssureIsOfTypeRejectionError
+
+// works great for inline validation
+const processUser = (input: { uuid: string }) => {
+  const userUuid: Uuid = assure(input.uuid, isUuid); // throws if invalid, narrows type if valid
+  // ...
+};
+```