@xylabs/assert 4.3.2 → 4.3.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,15 @@
1
+ import type { AssertExErrorFunc, AssertExMessageFunc } from './types.ts';
2
+ /**
3
+ *
4
+ * Intended for simple null/undefined checks for variables
5
+ *
6
+ * @param expr - Expression to be evaluated for truthiness
7
+ * @param message - Message in Error if expression is false, may be a function that returns a string
8
+ * @throws AssertExError
9
+ * @returns Value of expression
10
+ */
11
+ declare function assertDefinedEx<T>(expr: T | null | undefined): T;
12
+ declare function assertDefinedEx<T>(expr: T | null | undefined, messageFunc?: AssertExMessageFunc<T>): T;
13
+ declare function assertDefinedEx<T, R extends Error>(expr: T | null | undefined, errorFunc?: AssertExErrorFunc<T, R>): T;
14
+ export { assertDefinedEx };
15
+ //# sourceMappingURL=assertDefinedEx.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"assertDefinedEx.d.ts","sourceRoot":"","sources":["../../src/assertDefinedEx.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAA;AAExE;;;;;;;;GAQG;AACH,iBAAS,eAAe,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,IAAI,GAAG,SAAS,GAAG,CAAC,CAAA;AAC1D,iBAAS,eAAe,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,IAAI,GAAG,SAAS,EAAE,WAAW,CAAC,EAAE,mBAAmB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;AAChG,iBAAS,eAAe,CAAC,CAAC,EAAE,CAAC,SAAS,KAAK,EAAE,IAAI,EAAE,CAAC,GAAG,IAAI,GAAG,SAAS,EAAE,SAAS,CAAC,EAAE,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAA;AAchH,OAAO,EAAE,eAAe,EAAE,CAAA"}
@@ -0,0 +1,19 @@
1
+ import type { AssertExErrorFunc, AssertExMessageFunc } from './types.ts';
2
+ /**
3
+ *
4
+ * Intended for simple truthiness checks for variables
5
+ *
6
+ * @param expr - Expression to be evaluated for truthiness
7
+ * @param message - Message in Error if expression is false, may be a function that returns a string
8
+ * @throws AssertExError
9
+ * @returns Value of expression
10
+ */
11
+ declare function assertEx<T>(expr: T | null | undefined): T;
12
+ /**
13
+ * @deprecated - replace string with () => string
14
+ */
15
+ declare function assertEx<T>(expr: T | null | undefined, message?: string): T;
16
+ declare function assertEx<T>(expr: T | null | undefined, messageFunc?: AssertExMessageFunc<T>): T;
17
+ declare function assertEx<T, R extends Error>(expr: T | null | undefined, errorFunc?: AssertExErrorFunc<T, R>): T;
18
+ export { assertEx };
19
+ //# sourceMappingURL=assertEx.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"assertEx.d.ts","sourceRoot":"","sources":["../../src/assertEx.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAA;AAExE;;;;;;;;GAQG;AACH,iBAAS,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,IAAI,GAAG,SAAS,GAAG,CAAC,CAAA;AACnD;;GAEG;AACH,iBAAS,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,IAAI,GAAG,SAAS,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,CAAC,CAAA;AACrE,iBAAS,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,IAAI,GAAG,SAAS,EAAE,WAAW,CAAC,EAAE,mBAAmB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;AACzF,iBAAS,QAAQ,CAAC,CAAC,EAAE,CAAC,SAAS,KAAK,EAAE,IAAI,EAAE,CAAC,GAAG,IAAI,GAAG,SAAS,EAAE,SAAS,CAAC,EAAE,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAA;AAczG,OAAO,EAAE,QAAQ,EAAE,CAAA"}
@@ -1,20 +1,4 @@
1
- export type AssertExMessageFunc<T> = (value?: T | null) => string;
2
- export type AssertExErrorFunc<T, R extends Error> = (value?: T | null) => R;
3
- /**
4
- *
5
- * Intended for simple null/undefined checks for variables
6
- *
7
- * @param expr - Expression to be evaluated for truthiness
8
- * @param message - Message in Error if expression is false, may be a function that returns a string
9
- * @throws AssertExError
10
- * @returns Value of expression
11
- */
12
- declare function assertEx<T>(expr: T | null | undefined): T;
13
- /**
14
- * @deprecated - replace string with () => string
15
- */
16
- declare function assertEx<T>(expr: T | null | undefined, message?: string): T;
17
- declare function assertEx<T>(expr: T | null | undefined, messageFunc?: AssertExMessageFunc<T>): T;
18
- declare function assertEx<T, R extends Error>(expr: T | null | undefined, errorFunc?: AssertExErrorFunc<T, R>): T;
19
- export { assertEx };
1
+ export * from './assertDefinedEx.ts';
2
+ export * from './assertEx.ts';
3
+ export type * from './types.ts';
20
4
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,IAAI,KAAK,MAAM,CAAA;AACjE,MAAM,MAAM,iBAAiB,CAAC,CAAC,EAAE,CAAC,SAAS,KAAK,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,IAAI,KAAK,CAAC,CAAA;AAE3E;;;;;;;;GAQG;AACH,iBAAS,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,IAAI,GAAG,SAAS,GAAG,CAAC,CAAA;AACnD;;GAEG;AACH,iBAAS,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,IAAI,GAAG,SAAS,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,CAAC,CAAA;AACrE,iBAAS,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,IAAI,GAAG,SAAS,EAAE,WAAW,CAAC,EAAE,mBAAmB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;AACzF,iBAAS,QAAQ,CAAC,CAAC,EAAE,CAAC,SAAS,KAAK,EAAE,IAAI,EAAE,CAAC,GAAG,IAAI,GAAG,SAAS,EAAE,SAAS,CAAC,EAAE,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAA;AAczG,OAAO,EAAE,QAAQ,EAAE,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAA;AACpC,cAAc,eAAe,CAAA;AAC7B,mBAAmB,YAAY,CAAA"}
@@ -1,4 +1,14 @@
1
- // src/index.ts
1
+ // src/assertDefinedEx.ts
2
+ function assertDefinedEx(expr, messageOrFunc) {
3
+ if (expr !== void 0 && expr !== null) return expr;
4
+ if (typeof messageOrFunc === "function") {
5
+ const errorOrMessage = messageOrFunc(expr);
6
+ throw typeof errorOrMessage === "string" ? new Error(errorOrMessage) : errorOrMessage;
7
+ }
8
+ throw new Error(messageOrFunc);
9
+ }
10
+
11
+ // src/assertEx.ts
2
12
  function assertEx(expr, messageOrFunc) {
3
13
  if (expr) return expr;
4
14
  if (typeof messageOrFunc === "function") {
@@ -8,6 +18,7 @@ function assertEx(expr, messageOrFunc) {
8
18
  throw new Error(messageOrFunc);
9
19
  }
10
20
  export {
21
+ assertDefinedEx,
11
22
  assertEx
12
23
  };
13
24
  //# sourceMappingURL=index.mjs.map
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/index.ts"],"sourcesContent":["export type AssertExMessageFunc<T> = (value?: T | null) => string\nexport type AssertExErrorFunc<T, R extends Error> = (value?: T | null) => R\n\n/**\n *\n * Intended for simple null/undefined checks for variables\n *\n * @param expr - Expression to be evaluated for truthiness\n * @param message - Message in Error if expression is false, may be a function that returns a string\n * @throws AssertExError\n * @returns Value of expression\n */\nfunction assertEx<T>(expr: T | null | undefined): T\n/**\n * @deprecated - replace string with () => string\n */\nfunction assertEx<T>(expr: T | null | undefined, message?: string): T\nfunction assertEx<T>(expr: T | null | undefined, messageFunc?: AssertExMessageFunc<T>): T\nfunction assertEx<T, R extends Error>(expr: T | null | undefined, errorFunc?: AssertExErrorFunc<T, R>): T\nfunction assertEx<T, R extends Error, P extends string | AssertExMessageFunc<T> | AssertExErrorFunc<T, R>>(\n expr: T | null | undefined,\n messageOrFunc?: P,\n): T {\n if (expr) return expr\n if (typeof messageOrFunc === 'function') {\n const errorOrMessage = messageOrFunc(expr)\n throw typeof errorOrMessage === 'string' ? new Error(errorOrMessage) : errorOrMessage\n }\n // a string was sent\n throw new Error(messageOrFunc)\n}\n\nexport { assertEx }\n"],"mappings":";AAmBA,SAAS,SACP,MACA,eACG;AACH,MAAI,KAAM,QAAO;AACjB,MAAI,OAAO,kBAAkB,YAAY;AACvC,UAAM,iBAAiB,cAAc,IAAI;AACzC,UAAM,OAAO,mBAAmB,WAAW,IAAI,MAAM,cAAc,IAAI;AAAA,EACzE;AAEA,QAAM,IAAI,MAAM,aAAa;AAC/B;","names":[]}
1
+ {"version":3,"sources":["../../src/assertDefinedEx.ts","../../src/assertEx.ts"],"sourcesContent":["import type { AssertExErrorFunc, AssertExMessageFunc } from './types.ts'\n\n/**\n *\n * Intended for simple null/undefined checks for variables\n *\n * @param expr - Expression to be evaluated for truthiness\n * @param message - Message in Error if expression is false, may be a function that returns a string\n * @throws AssertExError\n * @returns Value of expression\n */\nfunction assertDefinedEx<T>(expr: T | null | undefined): T\nfunction assertDefinedEx<T>(expr: T | null | undefined, messageFunc?: AssertExMessageFunc<T>): T\nfunction assertDefinedEx<T, R extends Error>(expr: T | null | undefined, errorFunc?: AssertExErrorFunc<T, R>): T\nfunction assertDefinedEx<T, R extends Error, P extends string | AssertExMessageFunc<T> | AssertExErrorFunc<T, R>>(\n expr: T | null | undefined,\n messageOrFunc?: P,\n): T {\n if (expr !== undefined && expr !== null) return expr\n if (typeof messageOrFunc === 'function') {\n const errorOrMessage = messageOrFunc(expr)\n throw typeof errorOrMessage === 'string' ? new Error(errorOrMessage) : errorOrMessage\n }\n // a string was sent\n throw new Error(messageOrFunc)\n}\n\nexport { assertDefinedEx }\n","import type { AssertExErrorFunc, AssertExMessageFunc } from './types.ts'\n\n/**\n *\n * Intended for simple truthiness checks for variables\n *\n * @param expr - Expression to be evaluated for truthiness\n * @param message - Message in Error if expression is false, may be a function that returns a string\n * @throws AssertExError\n * @returns Value of expression\n */\nfunction assertEx<T>(expr: T | null | undefined): T\n/**\n * @deprecated - replace string with () => string\n */\nfunction assertEx<T>(expr: T | null | undefined, message?: string): T\nfunction assertEx<T>(expr: T | null | undefined, messageFunc?: AssertExMessageFunc<T>): T\nfunction assertEx<T, R extends Error>(expr: T | null | undefined, errorFunc?: AssertExErrorFunc<T, R>): T\nfunction assertEx<T, R extends Error, P extends string | AssertExMessageFunc<T> | AssertExErrorFunc<T, R>>(\n expr: T | null | undefined,\n messageOrFunc?: P,\n): T {\n if (expr) return expr\n if (typeof messageOrFunc === 'function') {\n const errorOrMessage = messageOrFunc(expr)\n throw typeof errorOrMessage === 'string' ? new Error(errorOrMessage) : errorOrMessage\n }\n // a string was sent\n throw new Error(messageOrFunc)\n}\n\nexport { assertEx }\n"],"mappings":";AAcA,SAAS,gBACP,MACA,eACG;AACH,MAAI,SAAS,UAAa,SAAS,KAAM,QAAO;AAChD,MAAI,OAAO,kBAAkB,YAAY;AACvC,UAAM,iBAAiB,cAAc,IAAI;AACzC,UAAM,OAAO,mBAAmB,WAAW,IAAI,MAAM,cAAc,IAAI;AAAA,EACzE;AAEA,QAAM,IAAI,MAAM,aAAa;AAC/B;;;ACPA,SAAS,SACP,MACA,eACG;AACH,MAAI,KAAM,QAAO;AACjB,MAAI,OAAO,kBAAkB,YAAY;AACvC,UAAM,iBAAiB,cAAc,IAAI;AACzC,UAAM,OAAO,mBAAmB,WAAW,IAAI,MAAM,cAAc,IAAI;AAAA,EACzE;AAEA,QAAM,IAAI,MAAM,aAAa;AAC/B;","names":[]}
@@ -0,0 +1,3 @@
1
+ export type AssertExMessageFunc<T> = (value?: T | null) => string;
2
+ export type AssertExErrorFunc<T, R extends Error> = (value?: T | null) => R;
3
+ //# sourceMappingURL=types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,IAAI,KAAK,MAAM,CAAA;AACjE,MAAM,MAAM,iBAAiB,CAAC,CAAC,EAAE,CAAC,SAAS,KAAK,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,IAAI,KAAK,CAAC,CAAA"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xylabs/assert",
3
- "version": "4.3.2",
3
+ "version": "4.3.3",
4
4
  "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
5
5
  "keywords": [
6
6
  "xylabs",
@@ -0,0 +1,28 @@
1
+ import type { AssertExErrorFunc, AssertExMessageFunc } from './types.ts'
2
+
3
+ /**
4
+ *
5
+ * Intended for simple null/undefined checks for variables
6
+ *
7
+ * @param expr - Expression to be evaluated for truthiness
8
+ * @param message - Message in Error if expression is false, may be a function that returns a string
9
+ * @throws AssertExError
10
+ * @returns Value of expression
11
+ */
12
+ function assertDefinedEx<T>(expr: T | null | undefined): T
13
+ function assertDefinedEx<T>(expr: T | null | undefined, messageFunc?: AssertExMessageFunc<T>): T
14
+ function assertDefinedEx<T, R extends Error>(expr: T | null | undefined, errorFunc?: AssertExErrorFunc<T, R>): T
15
+ function assertDefinedEx<T, R extends Error, P extends string | AssertExMessageFunc<T> | AssertExErrorFunc<T, R>>(
16
+ expr: T | null | undefined,
17
+ messageOrFunc?: P,
18
+ ): T {
19
+ if (expr !== undefined && expr !== null) return expr
20
+ if (typeof messageOrFunc === 'function') {
21
+ const errorOrMessage = messageOrFunc(expr)
22
+ throw typeof errorOrMessage === 'string' ? new Error(errorOrMessage) : errorOrMessage
23
+ }
24
+ // a string was sent
25
+ throw new Error(messageOrFunc)
26
+ }
27
+
28
+ export { assertDefinedEx }
@@ -0,0 +1,32 @@
1
+ import type { AssertExErrorFunc, AssertExMessageFunc } from './types.ts'
2
+
3
+ /**
4
+ *
5
+ * Intended for simple truthiness checks for variables
6
+ *
7
+ * @param expr - Expression to be evaluated for truthiness
8
+ * @param message - Message in Error if expression is false, may be a function that returns a string
9
+ * @throws AssertExError
10
+ * @returns Value of expression
11
+ */
12
+ function assertEx<T>(expr: T | null | undefined): T
13
+ /**
14
+ * @deprecated - replace string with () => string
15
+ */
16
+ function assertEx<T>(expr: T | null | undefined, message?: string): T
17
+ function assertEx<T>(expr: T | null | undefined, messageFunc?: AssertExMessageFunc<T>): T
18
+ function assertEx<T, R extends Error>(expr: T | null | undefined, errorFunc?: AssertExErrorFunc<T, R>): T
19
+ function assertEx<T, R extends Error, P extends string | AssertExMessageFunc<T> | AssertExErrorFunc<T, R>>(
20
+ expr: T | null | undefined,
21
+ messageOrFunc?: P,
22
+ ): T {
23
+ if (expr) return expr
24
+ if (typeof messageOrFunc === 'function') {
25
+ const errorOrMessage = messageOrFunc(expr)
26
+ throw typeof errorOrMessage === 'string' ? new Error(errorOrMessage) : errorOrMessage
27
+ }
28
+ // a string was sent
29
+ throw new Error(messageOrFunc)
30
+ }
31
+
32
+ export { assertEx }
package/src/index.ts CHANGED
@@ -1,33 +1,3 @@
1
- export type AssertExMessageFunc<T> = (value?: T | null) => string
2
- export type AssertExErrorFunc<T, R extends Error> = (value?: T | null) => R
3
-
4
- /**
5
- *
6
- * Intended for simple null/undefined checks for variables
7
- *
8
- * @param expr - Expression to be evaluated for truthiness
9
- * @param message - Message in Error if expression is false, may be a function that returns a string
10
- * @throws AssertExError
11
- * @returns Value of expression
12
- */
13
- function assertEx<T>(expr: T | null | undefined): T
14
- /**
15
- * @deprecated - replace string with () => string
16
- */
17
- function assertEx<T>(expr: T | null | undefined, message?: string): T
18
- function assertEx<T>(expr: T | null | undefined, messageFunc?: AssertExMessageFunc<T>): T
19
- function assertEx<T, R extends Error>(expr: T | null | undefined, errorFunc?: AssertExErrorFunc<T, R>): T
20
- function assertEx<T, R extends Error, P extends string | AssertExMessageFunc<T> | AssertExErrorFunc<T, R>>(
21
- expr: T | null | undefined,
22
- messageOrFunc?: P,
23
- ): T {
24
- if (expr) return expr
25
- if (typeof messageOrFunc === 'function') {
26
- const errorOrMessage = messageOrFunc(expr)
27
- throw typeof errorOrMessage === 'string' ? new Error(errorOrMessage) : errorOrMessage
28
- }
29
- // a string was sent
30
- throw new Error(messageOrFunc)
31
- }
32
-
33
- export { assertEx }
1
+ export * from './assertDefinedEx.ts'
2
+ export * from './assertEx.ts'
3
+ export type * from './types.ts'
package/src/types.ts ADDED
@@ -0,0 +1,2 @@
1
+ export type AssertExMessageFunc<T> = (value?: T | null) => string
2
+ export type AssertExErrorFunc<T, R extends Error> = (value?: T | null) => R