type-fns 1.17.0 → 1.18.0

package/dist/types/ArrayWith.d.ts

@@ -0,0 +1,12 @@
+/**
+ * ref:
+ * - https://stackoverflow.com/a/67655609/3068233
+ * - https://stackoverflow.com/a/73409753/3068233
+ */
+type BuildArrayWith<TCheck extends 'len' | 'min', // todo: support 'max' too?
+TLength extends number, TType, TCurrent extends TType[]> = TCurrent['length'] extends TLength ? TCheck extends 'len' ? [...TCurrent] : [...TCurrent, ...TType[]] : BuildArrayWith<TCheck, TLength, TType, [...TCurrent, TType]>;
+/**
+ * declares a type of array with a check on its length
+ */
+type ArrayWith<TCheck extends 'len' | 'min', // todo: support 'max' too?
+TLength extends number, TType> = BuildArrayWith<TCheck, TLength, TType, []>;

package/dist/types/ArrayWith.js

@@ -0,0 +1,2 @@
+"use strict";
+//# sourceMappingURL=ArrayWith.js.map

package/dist/types/ArrayWith.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ArrayWith.js","sourceRoot":"","sources":["../../src/types/ArrayWith.ts"],"names":[],"mappings":""}

package/dist/types/ArrayWith.test.d.ts

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

package/dist/types/ArrayWith.test.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const test_fns_1 = require("test-fns");
+describe('ArrayWith', () => {
+    (0, test_fns_1.given)('desire for array with min length', () => {
+        (0, test_fns_1.then)('we can declare the type', () => {
+            let products;
+        });
+        (0, test_fns_1.then)('it allows arrays of exactly the min length to it', () => {
+            const products = ['doughnut']; // 🍩
+        });
+        (0, test_fns_1.then)('it allows arrays with more than the min length to it', () => {
+            const products = ['doughnut', 'waffle']; // 🍩, 🧇
+        });
+        (0, test_fns_1.then)('it blocks arrays with less than the min length to it', () => {
+            // @ts-expect-error; Type '[]' is not assignable to type '[string, ...string[]]'. Source has 0 element(s) but target requires 1.ts(2322)
+            const products = []; // 🍩, 🧇
+        });
+    });
+    (0, test_fns_1.given)('desire for array with exact length', () => {
+        (0, test_fns_1.then)('we can declare the type', () => {
+            let products;
+        });
+        (0, test_fns_1.then)('it allows arrays of exactly the desired length to it', () => {
+            const products = ['doughnut']; // 🍩
+        });
+        (0, test_fns_1.then)('it allows arrays with more than the desired length to it', () => {
+            // @ts-expect-error; Type '[string, string]' is not assignable to type '[string]'.Source has 2 element(s) but target allows only 1.
+            const products = ['doughnut', 'waffle']; // 🍩, 🧇
+        });
+        (0, test_fns_1.then)('it blocks arrays with less than the desired length to it', () => {
+            // @ts-expect-error; Type '[]' is not assignable to type '[string]'. Source has 0 element(s) but target requires 1.ts(2322)
+            const products = [];
+        });
+    });
+});
+//# sourceMappingURL=ArrayWith.test.js.map

package/dist/types/ArrayWith.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ArrayWith.test.js","sourceRoot":"","sources":["../../src/types/ArrayWith.test.ts"],"names":[],"mappings":";;AAAA,uCAA6C;AAE7C,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;IACzB,IAAA,gBAAK,EAAC,kCAAkC,EAAE,GAAG,EAAE;QAC7C,IAAA,eAAI,EAAC,yBAAyB,EAAE,GAAG,EAAE;YACnC,IAAI,QAAqC,CAAC;QAC5C,CAAC,CAAC,CAAC;QACH,IAAA,eAAI,EAAC,kDAAkD,EAAE,GAAG,EAAE;YAC5D,MAAM,QAAQ,GAAgC,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK;QACnE,CAAC,CAAC,CAAC;QACH,IAAA,eAAI,EAAC,sDAAsD,EAAE,GAAG,EAAE;YAChE,MAAM,QAAQ,GAAgC,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC,SAAS;QACjF,CAAC,CAAC,CAAC;QACH,IAAA,eAAI,EAAC,sDAAsD,EAAE,GAAG,EAAE;YAChE,wIAAwI;YACxI,MAAM,QAAQ,GAAgC,EAAE,CAAC,CAAC,SAAS;QAC7D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IACH,IAAA,gBAAK,EAAC,oCAAoC,EAAE,GAAG,EAAE;QAC/C,IAAA,eAAI,EAAC,yBAAyB,EAAE,GAAG,EAAE;YACnC,IAAI,QAAqC,CAAC;QAC5C,CAAC,CAAC,CAAC;QACH,IAAA,eAAI,EAAC,sDAAsD,EAAE,GAAG,EAAE;YAChE,MAAM,QAAQ,GAAgC,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK;QACnE,CAAC,CAAC,CAAC;QACH,IAAA,eAAI,EAAC,0DAA0D,EAAE,GAAG,EAAE;YACpE,mIAAmI;YACnI,MAAM,QAAQ,GAAgC,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC,SAAS;QACjF,CAAC,CAAC,CAAC;QACH,IAAA,eAAI,EAAC,0DAA0D,EAAE,GAAG,EAAE;YACpE,2HAA2H;YAC3H,MAAM,QAAQ,GAAgC,EAAE,CAAC;QACnD,CAAC,CAAC,CAAC;IACL,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": "1.17.0",
+  "version": "1.18.0",
   "repository": "ehmpathy/type-fns",
   "homepage": "https://github.com/ehmpathy/type-fns",
   "keywords": [