@koine/utils 1.0.92 → 1.0.94

package/arrayOfAll.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Ensure an array contains all deisred values
+ *
+ * @category array
+ * @borrows [SO comment by `CertainPerformance`](https://stackoverflow.com/a/60132060/1938970)
+ *
+ * @usage
+ *
+ * ```
+ * import { arrayOfAll } from "@koine/utils";
+ *
+ * type Fruit = "pear" | "apple" | "orange";
+ *
+ * const arrayOfAllFruits = arrayOfAll<Fruit>();
+ *
+ * const allFruits = arrayOfAllFruits([
+ *  "pear",
+ *  "apple",
+ *  "orange"
+ * ]); // ts compiler ok
+ *
+ * const allFruits = arrayOfAllFruits([
+ *  "pear",
+ *  "apple",
+ * ]); // ts compiler fails
+ * ```
+ *
+ */
+export declare const arrayOfAll: <T>() => <U extends T[]>(array: U & ([T] extends [U[number]] ? unknown : "Invalid")) => U & ([T] extends [U[number]] ? unknown : "Invalid");
+export default arrayOfAll;

package/arrayOfAll.js

@@ -0,0 +1,34 @@
+/**
+ * Ensure an array contains all deisred values
+ *
+ * @category array
+ * @borrows [SO comment by `CertainPerformance`](https://stackoverflow.com/a/60132060/1938970)
+ *
+ * @usage
+ *
+ * ```
+ * import { arrayOfAll } from "@koine/utils";
+ *
+ * type Fruit = "pear" | "apple" | "orange";
+ *
+ * const arrayOfAllFruits = arrayOfAll<Fruit>();
+ *
+ * const allFruits = arrayOfAllFruits([
+ *  "pear",
+ *  "apple",
+ *  "orange"
+ * ]); // ts compiler ok
+ *
+ * const allFruits = arrayOfAllFruits([
+ *  "pear",
+ *  "apple",
+ * ]); // ts compiler fails
+ * ```
+ *
+ */
+export var arrayOfAll = function () {
+    return function (array) {
+        return array;
+    };
+};
+export default arrayOfAll;

package/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./accentSets";
 export * from "./addOrReplaceAtIdx";
+export * from "./arrayOfAll";
 export * from "./arrayToLookup";
 export * from "./buildUrlQueryString";
 export * from "./capitalize";

package/index.js

@@ -1,5 +1,6 @@
 export * from "./accentSets";
 export * from "./addOrReplaceAtIdx";
+export * from "./arrayOfAll";
 export * from "./arrayToLookup";
 export * from "./buildUrlQueryString";
 export * from "./capitalize";

package/node/arrayOfAll.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.arrayOfAll = void 0;
+/**
+ * Ensure an array contains all deisred values
+ *
+ * @category array
+ * @borrows [SO comment by `CertainPerformance`](https://stackoverflow.com/a/60132060/1938970)
+ *
+ * @usage
+ *
+ * ```
+ * import { arrayOfAll } from "@koine/utils";
+ *
+ * type Fruit = "pear" | "apple" | "orange";
+ *
+ * const arrayOfAllFruits = arrayOfAll<Fruit>();
+ *
+ * const allFruits = arrayOfAllFruits([
+ *  "pear",
+ *  "apple",
+ *  "orange"
+ * ]); // ts compiler ok
+ *
+ * const allFruits = arrayOfAllFruits([
+ *  "pear",
+ *  "apple",
+ * ]); // ts compiler fails
+ * ```
+ *
+ */
+var arrayOfAll = function () {
+    return function (array) {
+        return array;
+    };
+};
+exports.arrayOfAll = arrayOfAll;
+exports.default = exports.arrayOfAll;

package/node/index.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./accentSets"), exports);
 tslib_1.__exportStar(require("./addOrReplaceAtIdx"), exports);
+tslib_1.__exportStar(require("./arrayOfAll"), exports);
 tslib_1.__exportStar(require("./arrayToLookup"), exports);
 tslib_1.__exportStar(require("./buildUrlQueryString"), exports);
 tslib_1.__exportStar(require("./capitalize"), exports);

package/package.json

@@ -8,7 +8,7 @@
     "tslib": "^2.4.0"
   },
   "peerDependencies": {},
-  "version": "1.0.92",
+  "version": "1.0.94",
   "module": "./index.js",
   "types": "./index.d.ts"
 }