@infra-blocks/types 0.21.0 → 0.22.0-alpha.0

package/lib/cjs/types.d.ts

@@ -1,3 +1,28 @@
+/**
+ * The unique symbol used for branding types.
+ */
+export declare const brand: unique symbol;
+/**
+ * Declares the branding of a type.
+ *
+ * Branding a type circumvent TypeScript's structural typing by adding an unique property to a type,
+ * making it incompatible with other types even if they share the same structure.
+ *
+ * Use it as such:
+ * ```typescript
+ * type UserId = string & Brand<"UserId">;
+ *
+ * // The proper way to obtain a UserId.
+ * function parseUserId(id: string): UserId {
+ *  ...
+ * }
+ * ```
+ */
+export type Brand<T extends string | number | symbol = string | number | symbol> = {
+    [brand]: {
+        [k in T]: true;
+    };
+};
 /**
  * Convenience type to represent environment variables.
  */

package/lib/cjs/types.js

@@ -1,3 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.brand = void 0;
+/**
+ * The unique symbol used for branding types.
+ */
+exports.brand = Symbol("__brand");
 //# sourceMappingURL=types.js.map

package/lib/cjs/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":""}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACU,QAAA,KAAK,GAAkB,MAAM,CAAC,SAAS,CAAC,CAAC"}

package/lib/esm/types.d.ts

@@ -1,3 +1,28 @@
+/**
+ * The unique symbol used for branding types.
+ */
+export declare const brand: unique symbol;
+/**
+ * Declares the branding of a type.
+ *
+ * Branding a type circumvent TypeScript's structural typing by adding an unique property to a type,
+ * making it incompatible with other types even if they share the same structure.
+ *
+ * Use it as such:
+ * ```typescript
+ * type UserId = string & Brand<"UserId">;
+ *
+ * // The proper way to obtain a UserId.
+ * function parseUserId(id: string): UserId {
+ *  ...
+ * }
+ * ```
+ */
+export type Brand<T extends string | number | symbol = string | number | symbol> = {
+    [brand]: {
+        [k in T]: true;
+    };
+};
 /**
  * Convenience type to represent environment variables.
  */

package/lib/esm/types.js

@@ -1,2 +1,5 @@
-export {};
+/**
+ * The unique symbol used for branding types.
+ */
+export const brand = Symbol("__brand");
 //# sourceMappingURL=types.js.map

package/lib/esm/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":""}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,MAAM,KAAK,GAAkB,MAAM,CAAC,SAAS,CAAC,CAAC"}

package/package.json

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