@xylabs/assert 2.7.3 → 2.7.5

package/dist/cjs/index.js

@@ -11,14 +11,14 @@ class AssertExError extends Error {
  * Intended for simple null/undefined checks for variables
  *
  * @param expr - Expression to be evaluated for truthiness
- * @param message - Message in Error if expression is false
+ * @param message - Message in Error if expression is false, may be a function that returns a string
  * @throws AssertExError
  * @returns Value of expression
  */
 const assertEx = (expr, message) => {
     if (expr)
         return expr;
-    throw new AssertExError(message);
+    throw new AssertExError(typeof message === 'string' ? message : message === null || message === void 0 ? void 0 : message(expr));
 };
 exports.assertEx = assertEx;
 // eslint-disable-next-line import/no-default-export

package/dist/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,MAAM,aAAc,SAAQ,KAAK;CAAG;AAEpC;;;;;;;;GAQG;AACH,MAAM,QAAQ,GAAG,CAAI,IAAe,EAAE,OAAgB,EAAK,EAAE;IAC3D,IAAI,IAAI;QAAE,OAAO,IAAI,CAAA;IACrB,MAAM,IAAI,aAAa,CAAC,OAAO,CAAC,CAAA;AAClC,CAAC,CAAA;AAEQ,4BAAQ;AAEjB,oDAAoD;AACpD,kBAAe,QAAQ,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,MAAM,aAAc,SAAQ,KAAK;CAAG;AAIpC;;;;;;;;GAQG;AACH,MAAM,QAAQ,GAAG,CAAI,IAAe,EAAE,OAAsC,EAAK,EAAE;IACjF,IAAI,IAAI;QAAE,OAAO,IAAI,CAAA;IACrB,MAAM,IAAI,aAAa,CAAC,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAG,IAAI,CAAC,CAAC,CAAA;AAClF,CAAC,CAAA;AAKQ,4BAAQ;AAHjB,oDAAoD;AACpD,kBAAe,QAAQ,CAAA"}

package/dist/docs.json

@@ -7,7 +7,7 @@
 	"originalName": "",
 	"children": [
 		{
-			"id": 6,
+			"id": 11,
 			"name": "default",
 			"kind": 8388608,
 			"kindString": "Reference",
@@ -17,13 +17,82 @@
 					"fileName": "index.ts",
 					"line": 23,
 					"character": 0,
-					"url": "https://github.com/xylabs/sdk-js/blob/860e19d/packages/assert/src/index.ts#L23"
+					"url": "https://github.com/xylabs/sdk-js/blob/09e8e07/packages/assert/src/index.ts#L23"
 				}
 			],
-			"target": 1
+			"target": 6
 		},
 		{
 			"id": 1,
+			"name": "AssertExMessageFunc",
+			"kind": 4194304,
+			"kindString": "Type alias",
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "index.ts",
+					"line": 6,
+					"character": 12,
+					"url": "https://github.com/xylabs/sdk-js/blob/09e8e07/packages/assert/src/index.ts#L6"
+				}
+			],
+			"type": {
+				"type": "reflection",
+				"declaration": {
+					"id": 2,
+					"name": "__type",
+					"kind": 65536,
+					"kindString": "Type literal",
+					"flags": {},
+					"sources": [
+						{
+							"fileName": "index.ts",
+							"line": 6,
+							"character": 34,
+							"url": "https://github.com/xylabs/sdk-js/blob/09e8e07/packages/assert/src/index.ts#L6"
+						}
+					],
+					"signatures": [
+						{
+							"id": 3,
+							"name": "__type",
+							"kind": 4096,
+							"kindString": "Call signature",
+							"flags": {},
+							"typeParameter": [
+								{
+									"id": 5,
+									"name": "T",
+									"kind": 131072,
+									"kindString": "Type parameter",
+									"flags": {}
+								}
+							],
+							"parameters": [
+								{
+									"id": 4,
+									"name": "value",
+									"kind": 32768,
+									"kindString": "Parameter",
+									"flags": {},
+									"type": {
+										"type": "reference",
+										"id": 5,
+										"name": "T"
+									}
+								}
+							],
+							"type": {
+								"type": "intrinsic",
+								"name": "string"
+							}
+						}
+					]
+				}
+			}
+		},
+		{
+			"id": 6,
 			"name": "assertEx",
 			"kind": 64,
 			"kindString": "Function",
@@ -31,14 +100,14 @@
 			"sources": [
 				{
 					"fileName": "index.ts",
-					"line": 15,
+					"line": 17,
 					"character": 6,
-					"url": "https://github.com/xylabs/sdk-js/blob/860e19d/packages/assert/src/index.ts#L15"
+					"url": "https://github.com/xylabs/sdk-js/blob/09e8e07/packages/assert/src/index.ts#L17"
 				}
 			],
 			"signatures": [
 				{
-					"id": 2,
+					"id": 7,
 					"name": "assertEx",
 					"kind": 4096,
 					"kindString": "Call signature",
@@ -73,7 +142,7 @@
 					},
 					"typeParameter": [
 						{
-							"id": 3,
+							"id": 8,
 							"name": "T",
 							"kind": 131072,
 							"kindString": "Type parameter",
@@ -82,7 +151,7 @@
 					],
 					"parameters": [
 						{
-							"id": 4,
+							"id": 9,
 							"name": "expr",
 							"kind": 32768,
 							"kindString": "Parameter",
@@ -106,14 +175,14 @@
 									},
 									{
 										"type": "reference",
-										"id": 3,
+										"id": 8,
 										"name": "T"
 									}
 								]
 							}
 						},
 						{
-							"id": 5,
+							"id": 10,
 							"name": "message",
 							"kind": 32768,
 							"kindString": "Parameter",
@@ -124,19 +193,29 @@
 								"summary": [
 									{
 										"kind": "text",
-										"text": "Message in Error if expression is false"
+										"text": "Message in Error if expression is false, may be a function that returns a string"
 									}
 								]
 							},
 							"type": {
-								"type": "intrinsic",
-								"name": "string"
+								"type": "union",
+								"types": [
+									{
+										"type": "intrinsic",
+										"name": "string"
+									},
+									{
+										"type": "reference",
+										"id": 1,
+										"name": "AssertExMessageFunc"
+									}
+								]
 							}
 						}
 					],
 					"type": {
 						"type": "reference",
-						"id": 3,
+						"id": 8,
 						"name": "T"
 					}
 				}
@@ -147,14 +226,20 @@
 		{
 			"title": "References",
 			"children": [
-				6
+				11
 			]
 		},
 		{
-			"title": "Functions",
+			"title": "Type Aliases",
 			"children": [
 				1
 			]
+		},
+		{
+			"title": "Functions",
+			"children": [
+				6
+			]
 		}
 	],
 	"sources": [
@@ -162,7 +247,7 @@
 			"fileName": "index.ts",
 			"line": 4,
 			"character": 0,
-			"url": "https://github.com/xylabs/sdk-js/blob/860e19d/packages/assert/src/index.ts#L4"
+			"url": "https://github.com/xylabs/sdk-js/blob/09e8e07/packages/assert/src/index.ts#L4"
 		}
 	]
 }

package/dist/esm/index.js

@@ -8,16 +8,16 @@ class AssertExError extends Error {
  * Intended for simple null/undefined checks for variables
  *
  * @param expr - Expression to be evaluated for truthiness
- * @param message - Message in Error if expression is false
+ * @param message - Message in Error if expression is false, may be a function that returns a string
  * @throws AssertExError
  * @returns Value of expression
  */
 const assertEx = (expr, message) => {
     if (expr)
         return expr;
-    throw new AssertExError(message);
+    throw new AssertExError(typeof message === 'string' ? message : message?.(expr));
 };
-export { assertEx };
 // eslint-disable-next-line import/no-default-export
 export default assertEx;
+export { assertEx };
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,aAAc,SAAQ,KAAK;CAAG;AAEpC;;;;;;;;GAQG;AACH,MAAM,QAAQ,GAAG,CAAI,IAAe,EAAE,OAAgB,EAAK,EAAE;IAC3D,IAAI,IAAI;QAAE,OAAO,IAAI,CAAA;IACrB,MAAM,IAAI,aAAa,CAAC,OAAO,CAAC,CAAA;AAClC,CAAC,CAAA;AAED,OAAO,EAAE,QAAQ,EAAE,CAAA;AAEnB,oDAAoD;AACpD,eAAe,QAAQ,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,aAAc,SAAQ,KAAK;CAAG;AAIpC;;;;;;;;GAQG;AACH,MAAM,QAAQ,GAAG,CAAI,IAAe,EAAE,OAAsC,EAAK,EAAE;IACjF,IAAI,IAAI;QAAE,OAAO,IAAI,CAAA;IACrB,MAAM,IAAI,aAAa,CAAC,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC,CAAA;AAClF,CAAC,CAAA;AAED,oDAAoD;AACpD,eAAe,QAAQ,CAAA;AAEvB,OAAO,EAAE,QAAQ,EAAE,CAAA"}

package/dist/types/index.d.ts

@@ -1,13 +1,14 @@
+export type AssertExMessageFunc = <T>(value: T) => string;
 /**
  *
  * Intended for simple null/undefined checks for variables
  *
  * @param expr - Expression to be evaluated for truthiness
- * @param message - Message in Error if expression is false
+ * @param message - Message in Error if expression is false, may be a function that returns a string
  * @throws AssertExError
  * @returns Value of expression
  */
-declare const assertEx: <T>(expr?: T | null | undefined, message?: string) => T;
-export { assertEx };
+declare const assertEx: <T>(expr?: T | null | undefined, message?: string | AssertExMessageFunc) => T;
 export default assertEx;
+export { assertEx };
 //# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAKA;;;;;;;;GAQG;AACH,QAAA,MAAM,QAAQ,6CAAkC,MAAM,MAGrD,CAAA;AAED,OAAO,EAAE,QAAQ,EAAE,CAAA;AAGnB,eAAe,QAAQ,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAKA,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,KAAK,MAAM,CAAA;AAEzD;;;;;;;;GAQG;AACH,QAAA,MAAM,QAAQ,6CAAkC,MAAM,GAAG,mBAAmB,MAG3E,CAAA;AAGD,eAAe,QAAQ,CAAA;AAEvB,OAAO,EAAE,QAAQ,EAAE,CAAA"}

package/package.json

@@ -34,7 +34,7 @@
     "./package.json": "./package.json"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^2.15.0"
+    "@xylabs/ts-scripts-yarn3": "^2.16.1"
   },
   "homepage": "https://xylabs.com",
   "keywords": [
@@ -51,5 +51,5 @@
     "url": "https://github.com/xylabs/sdk-js.git"
   },
   "sideEffects": false,
-  "version": "2.7.3"
+  "version": "2.7.5"
 }

package/src/index.ts

@@ -3,21 +3,23 @@
  */
 class AssertExError extends Error {}
 
+export type AssertExMessageFunc = <T>(value: T) => string
+
 /**
  *
  * Intended for simple null/undefined checks for variables
  *
  * @param expr - Expression to be evaluated for truthiness
- * @param message - Message in Error if expression is false
+ * @param message - Message in Error if expression is false, may be a function that returns a string
  * @throws AssertExError
  * @returns Value of expression
  */
-const assertEx = <T>(expr?: T | null, message?: string): T => {
+const assertEx = <T>(expr?: T | null, message?: string | AssertExMessageFunc): T => {
   if (expr) return expr
-  throw new AssertExError(message)
+  throw new AssertExError(typeof message === 'string' ? message : message?.(expr))
 }
 
-export { assertEx }
-
 // eslint-disable-next-line import/no-default-export
 export default assertEx
+
+export { assertEx }