@infra-blocks/types 0.7.0 → 0.8.0-alpha.0

package/lib/cjs/index.d.ts

@@ -50,3 +50,23 @@ export type TransitivePartial<T> = {
 export type KeyOfType<T, U> = {
     [P in keyof T]: T[P] extends U ? P : never;
 }[keyof T];
+/**
+ * A function for forcing exhaustiveness in switch statements or if-else chains.
+ *
+ * @example
+ * type BigType = "penus" | "penii";
+ * let x: BigType = "penus";
+ * switch (x) {
+ *  case "penus":
+ *    // handle penus
+ *    break;
+ *  case "penii":
+ *    // handle penii
+ *    break;
+ *  default:
+ *    unreachable(x); // This will not compile if the switch is not exhaustive.
+ * }
+ *
+ * @param value - The value to validate against never.
+ */
+export declare function unreachable(value: never): never;

package/lib/cjs/index.js

@@ -14,7 +14,31 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.unreachable = void 0;
 __exportStar(require("./func.js"), exports);
 __exportStar(require("./guard.js"), exports);
 __exportStar(require("./events.js"), exports);
+/**
+ * A function for forcing exhaustiveness in switch statements or if-else chains.
+ *
+ * @example
+ * type BigType = "penus" | "penii";
+ * let x: BigType = "penus";
+ * switch (x) {
+ *  case "penus":
+ *    // handle penus
+ *    break;
+ *  case "penii":
+ *    // handle penii
+ *    break;
+ *  default:
+ *    unreachable(x); // This will not compile if the switch is not exhaustive.
+ * }
+ *
+ * @param value - The value to validate against never.
+ */
+function unreachable(value) {
+    return value;
+}
+exports.unreachable = unreachable;
 //# sourceMappingURL=index.js.map

package/lib/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAA0B;AAC1B,6CAA2B;AAC3B,8CAA4B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,4CAA0B;AAC1B,6CAA2B;AAC3B,8CAA4B;AAyD5B;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAgB,WAAW,CAAC,KAAY;IACtC,OAAO,KAAK,CAAC;AACf,CAAC;AAFD,kCAEC"}

package/lib/esm/index.d.ts

@@ -50,3 +50,23 @@ export type TransitivePartial<T> = {
 export type KeyOfType<T, U> = {
     [P in keyof T]: T[P] extends U ? P : never;
 }[keyof T];
+/**
+ * A function for forcing exhaustiveness in switch statements or if-else chains.
+ *
+ * @example
+ * type BigType = "penus" | "penii";
+ * let x: BigType = "penus";
+ * switch (x) {
+ *  case "penus":
+ *    // handle penus
+ *    break;
+ *  case "penii":
+ *    // handle penii
+ *    break;
+ *  default:
+ *    unreachable(x); // This will not compile if the switch is not exhaustive.
+ * }
+ *
+ * @param value - The value to validate against never.
+ */
+export declare function unreachable(value: never): never;

package/lib/esm/index.js

@@ -1,4 +1,26 @@
 export * from "./func.js";
 export * from "./guard.js";
 export * from "./events.js";
+/**
+ * A function for forcing exhaustiveness in switch statements or if-else chains.
+ *
+ * @example
+ * type BigType = "penus" | "penii";
+ * let x: BigType = "penus";
+ * switch (x) {
+ *  case "penus":
+ *    // handle penus
+ *    break;
+ *  case "penii":
+ *    // handle penii
+ *    break;
+ *  default:
+ *    unreachable(x); // This will not compile if the switch is not exhaustive.
+ * }
+ *
+ * @param value - The value to validate against never.
+ */
+export function unreachable(value) {
+    return value;
+}
 //# sourceMappingURL=index.js.map

package/lib/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAyD5B;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,WAAW,CAAC,KAAY;IACtC,OAAO,KAAK,CAAC;AACf,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@infra-blocks/types",
-  "version": "0.7.0",
+  "version": "0.8.0-alpha.0",
   "description": "Typescript types utility package.",
   "keywords": [
     "type",