@xylabs/error 5.0.83 → 5.0.86

package/README.md

@@ -15,6 +15,8 @@
 
 Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
+
+
 ## Reference
 
 **@xylabs/error**
@@ -23,14 +25,18 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
 ## Type Aliases
 
-- [AssertConfig](#type-aliases/AssertConfig)
+| Type Alias | Description |
+| ------ | ------ |
+| [AssertConfig](#type-aliases/AssertConfig) | Configuration for assertion behavior: a static message string, a boolean toggle, or a callback. |
 
 ## Functions
 
-- [assertError](#functions/assertError)
-- [handleError](#functions/handleError)
-- [handleErrorAsync](#functions/handleErrorAsync)
-- [isError](#functions/isError)
+| Function | Description |
+| ------ | ------ |
+| [assertError](#functions/assertError) | Throws an Error based on the assert configuration when a value fails validation. |
+| [handleError](#functions/handleError) | Invokes the handler if the value is an Error, otherwise re-throws it. |
+| [handleErrorAsync](#functions/handleErrorAsync) | Async version of handleError. Invokes the async handler if the value is an Error, otherwise re-throws it. |
+| [isError](#functions/isError) | Type guard that checks whether a value is an Error instance. |
 
 ### functions
 
@@ -42,24 +48,20 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
 ```ts
 function assertError(
-   value, 
-   assert, 
-   defaultMessage): undefined;
+   value: unknown, 
+   assert: AssertConfig | undefined, 
+   defaultMessage: string): undefined;
 ```
 
-## Parameters
-
-### value
+Throws an Error based on the assert configuration when a value fails validation.
 
-`unknown`
-
-### assert
-
-[`AssertConfig`](#../type-aliases/AssertConfig) | `undefined`
-
-### defaultMessage
+## Parameters
 
-`string`
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `unknown` | The value being validated |
+| `assert` | [`AssertConfig`](#../type-aliases/AssertConfig) \| `undefined` | Assertion config controlling the error message |
+| `defaultMessage` | `string` | Fallback message if no custom message is provided |
 
 ## Returns
 
@@ -72,29 +74,30 @@ function assertError(
 ***
 
 ```ts
-function handleError<T>(error, handler): T;
+function handleError<T>(error: any, handler: (error: Error) => T): T;
 ```
 
-## Type Parameters
+Invokes the handler if the value is an Error, otherwise re-throws it.
 
-### T
+## Type Parameters
 
-`T`
+| Type Parameter |
+| ------ |
+| `T` |
 
 ## Parameters
 
-### error
-
-`any`
-
-### handler
-
-(`error`) => `T`
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `error` | `any` | The caught value to inspect |
+| `handler` | (`error`: `Error`) => `T` | Callback invoked with the Error if it is one |
 
 ## Returns
 
 `T`
 
+The handler's return value
+
   ### <a id="handleErrorAsync"></a>handleErrorAsync
 
 [**@xylabs/error**](#../README)
@@ -102,29 +105,30 @@ function handleError<T>(error, handler): T;
 ***
 
 ```ts
-function handleErrorAsync<T>(error, handler): Promise<T>;
+function handleErrorAsync<T>(error: any, handler: (error: Error) => Promise<T>): Promise<T>;
 ```
 
-## Type Parameters
+Async version of handleError. Invokes the async handler if the value is an Error, otherwise re-throws it.
 
-### T
+## Type Parameters
 
-`T`
+| Type Parameter |
+| ------ |
+| `T` |
 
 ## Parameters
 
-### error
-
-`any`
-
-### handler
-
-(`error`) => `Promise`\<`T`\>
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `error` | `any` | The caught value to inspect |
+| `handler` | (`error`: `Error`) => `Promise`\<`T`\> | Async callback invoked with the Error if it is one |
 
 ## Returns
 
 `Promise`\<`T`\>
 
+The handler's resolved return value
+
   ### <a id="isError"></a>isError
 
 [**@xylabs/error**](#../README)
@@ -134,14 +138,16 @@ function handleErrorAsync<T>(error, handler): Promise<T>;
 ## Call Signature
 
 ```ts
-function isError(value): value is Error;
+function isError(value: unknown): value is Error;
 ```
 
-### Parameters
+Type guard that checks whether a value is an Error instance.
 
-### value
+### Parameters
 
-`unknown`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
 
 ### Returns
 
@@ -150,20 +156,22 @@ function isError(value): value is Error;
 ## Call Signature
 
 ```ts
-function isError<T>(value): value is Extract<T, Error>;
+function isError<T>(value: T): value is Extract<T, Error>;
 ```
 
-### Type Parameters
+Type guard that checks whether a value is an Error instance.
 
-### T
+### Type Parameters
 
-`T`
+| Type Parameter |
+| ------ |
+| `T` |
 
 ### Parameters
 
-### value
-
-`T`
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
 
 ### Returns
 
@@ -181,6 +189,8 @@ function isError<T>(value): value is Extract<T, Error>;
 type AssertConfig = string | AssertCallback | boolean;
 ```
 
+Configuration for assertion behavior: a static message string, a boolean toggle, or a callback.
+
 
 Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
 

package/dist/neutral/assert.d.ts

@@ -1,5 +1,12 @@
 type AssertCallback = (value: unknown, message: string) => string | boolean;
+/** Configuration for assertion behavior: a static message string, a boolean toggle, or a callback. */
 export type AssertConfig = string | AssertCallback | boolean;
+/**
+ * Throws an Error based on the assert configuration when a value fails validation.
+ * @param value - The value being validated
+ * @param assert - Assertion config controlling the error message
+ * @param defaultMessage - Fallback message if no custom message is provided
+ */
 export declare const assertError: (value: unknown, assert: AssertConfig | undefined, defaultMessage: string) => undefined;
 export {};
 //# sourceMappingURL=assert.d.ts.map

package/dist/neutral/assert.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"assert.d.ts","sourceRoot":"","sources":["../../src/assert.ts"],"names":[],"mappings":"AAEA,KAAK,cAAc,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,KAAK,MAAM,GAAG,OAAO,CAAA;AAE3E,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,cAAc,GAAG,OAAO,CAAA;AAE5D,eAAO,MAAM,WAAW,GAAI,OAAO,OAAO,EAAE,QAAQ,YAAY,GAAG,SAAS,EAAE,gBAAgB,MAAM,cAcnG,CAAA"}
+{"version":3,"file":"assert.d.ts","sourceRoot":"","sources":["../../src/assert.ts"],"names":[],"mappings":"AAEA,KAAK,cAAc,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,KAAK,MAAM,GAAG,OAAO,CAAA;AAE3E,sGAAsG;AACtG,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,cAAc,GAAG,OAAO,CAAA;AAE5D;;;;;GAKG;AACH,eAAO,MAAM,WAAW,GAAI,OAAO,OAAO,EAAE,QAAQ,YAAY,GAAG,SAAS,EAAE,gBAAgB,MAAM,cAcnG,CAAA"}

package/dist/neutral/handleError.d.ts

@@ -1,3 +1,15 @@
+/**
+ * Invokes the handler if the value is an Error, otherwise re-throws it.
+ * @param error - The caught value to inspect
+ * @param handler - Callback invoked with the Error if it is one
+ * @returns The handler's return value
+ */
 export declare const handleError: <T>(error: any, handler: (error: Error) => T) => T;
+/**
+ * Async version of handleError. Invokes the async handler if the value is an Error, otherwise re-throws it.
+ * @param error - The caught value to inspect
+ * @param handler - Async callback invoked with the Error if it is one
+ * @returns The handler's resolved return value
+ */
 export declare const handleErrorAsync: <T>(error: any, handler: (error: Error) => Promise<T>) => Promise<T>;
 //# sourceMappingURL=handleError.d.ts.map

package/dist/neutral/handleError.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"handleError.d.ts","sourceRoot":"","sources":["../../src/handleError.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,WAAW,GAAI,CAAC,EAAE,OAAO,GAAG,EAAE,SAAS,CAAC,KAAK,EAAE,KAAK,KAAK,CAAC,MAMtE,CAAA;AAGD,eAAO,MAAM,gBAAgB,GAAU,CAAC,EAAE,OAAO,GAAG,EAAE,SAAS,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,CAAC,CAAC,CAAC,eAM1F,CAAA"}
+{"version":3,"file":"handleError.d.ts","sourceRoot":"","sources":["../../src/handleError.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AAEH,eAAO,MAAM,WAAW,GAAI,CAAC,EAAE,OAAO,GAAG,EAAE,SAAS,CAAC,KAAK,EAAE,KAAK,KAAK,CAAC,MAMtE,CAAA;AAED;;;;;GAKG;AAEH,eAAO,MAAM,gBAAgB,GAAU,CAAC,EAAE,OAAO,GAAG,EAAE,SAAS,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,CAAC,CAAC,CAAC,eAM1F,CAAA"}

package/dist/neutral/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/assert.ts","../../src/handleError.ts","../../src/index.ts"],"sourcesContent":["import { isString, isUndefined } from '@xylabs/typeof'\n\ntype AssertCallback = (value: unknown, message: string) => string | boolean\n\nexport type AssertConfig = string | AssertCallback | boolean\n\nexport const assertError = (value: unknown, assert: AssertConfig | undefined, defaultMessage: string) => {\n  if (!isUndefined(assert)) {\n    const assertString\n      = typeof assert === 'string'\n        ? assert\n        : typeof assert === 'boolean'\n          ? defaultMessage\n          : assert(value, defaultMessage)\n    if (isString(assertString) || assertString === true) {\n      throw new Error(assertString === true ? defaultMessage : assertString)\n    }\n  }\n  // eslint-disable-next-line unicorn/no-useless-undefined\n  return undefined\n}\n","import { isError } from '@xylabs/typeof'\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport const handleError = <T>(error: any, handler: (error: Error) => T) => {\n  if (isError(error)) {\n    return handler(error)\n  } else {\n    throw error\n  }\n}\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport const handleErrorAsync = async <T>(error: any, handler: (error: Error) => Promise<T>) => {\n  if (isError(error)) {\n    return await handler(error)\n  } else {\n    throw error\n  }\n}\n","export * from './assert.ts'\nexport * from './handleError.ts'\nexport { isError } from '@xylabs/typeof'\n"],"mappings":";AAAA,SAAS,UAAU,mBAAmB;AAM/B,IAAM,cAAc,CAAC,OAAgB,QAAkC,mBAA2B;AACvG,MAAI,CAAC,YAAY,MAAM,GAAG;AACxB,UAAM,eACF,OAAO,WAAW,WAChB,SACA,OAAO,WAAW,YAChB,iBACA,OAAO,OAAO,cAAc;AACpC,QAAI,SAAS,YAAY,KAAK,iBAAiB,MAAM;AACnD,YAAM,IAAI,MAAM,iBAAiB,OAAO,iBAAiB,YAAY;AAAA,IACvE;AAAA,EACF;AAEA,SAAO;AACT;;;ACpBA,SAAS,eAAe;AAGjB,IAAM,cAAc,CAAI,OAAY,YAAiC;AAC1E,MAAI,QAAQ,KAAK,GAAG;AAClB,WAAO,QAAQ,KAAK;AAAA,EACtB,OAAO;AACL,UAAM;AAAA,EACR;AACF;AAGO,IAAM,mBAAmB,OAAU,OAAY,YAA0C;AAC9F,MAAI,QAAQ,KAAK,GAAG;AAClB,WAAO,MAAM,QAAQ,KAAK;AAAA,EAC5B,OAAO;AACL,UAAM;AAAA,EACR;AACF;;;AChBA,SAAS,WAAAA,gBAAe;","names":["isError"]}
+{"version":3,"sources":["../../src/assert.ts","../../src/handleError.ts","../../src/index.ts"],"sourcesContent":["import { isString, isUndefined } from '@xylabs/typeof'\n\ntype AssertCallback = (value: unknown, message: string) => string | boolean\n\n/** Configuration for assertion behavior: a static message string, a boolean toggle, or a callback. */\nexport type AssertConfig = string | AssertCallback | boolean\n\n/**\n * Throws an Error based on the assert configuration when a value fails validation.\n * @param value - The value being validated\n * @param assert - Assertion config controlling the error message\n * @param defaultMessage - Fallback message if no custom message is provided\n */\nexport const assertError = (value: unknown, assert: AssertConfig | undefined, defaultMessage: string) => {\n  if (!isUndefined(assert)) {\n    const assertString\n      = typeof assert === 'string'\n        ? assert\n        : typeof assert === 'boolean'\n          ? defaultMessage\n          : assert(value, defaultMessage)\n    if (isString(assertString) || assertString === true) {\n      throw new Error(assertString === true ? defaultMessage : assertString)\n    }\n  }\n  // eslint-disable-next-line unicorn/no-useless-undefined\n  return undefined\n}\n","import { isError } from '@xylabs/typeof'\n\n/**\n * Invokes the handler if the value is an Error, otherwise re-throws it.\n * @param error - The caught value to inspect\n * @param handler - Callback invoked with the Error if it is one\n * @returns The handler's return value\n */\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport const handleError = <T>(error: any, handler: (error: Error) => T) => {\n  if (isError(error)) {\n    return handler(error)\n  } else {\n    throw error\n  }\n}\n\n/**\n * Async version of handleError. Invokes the async handler if the value is an Error, otherwise re-throws it.\n * @param error - The caught value to inspect\n * @param handler - Async callback invoked with the Error if it is one\n * @returns The handler's resolved return value\n */\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport const handleErrorAsync = async <T>(error: any, handler: (error: Error) => Promise<T>) => {\n  if (isError(error)) {\n    return await handler(error)\n  } else {\n    throw error\n  }\n}\n","export * from './assert.ts'\nexport * from './handleError.ts'\nexport { isError } from '@xylabs/typeof'\n"],"mappings":";AAAA,SAAS,UAAU,mBAAmB;AAa/B,IAAM,cAAc,CAAC,OAAgB,QAAkC,mBAA2B;AACvG,MAAI,CAAC,YAAY,MAAM,GAAG;AACxB,UAAM,eACF,OAAO,WAAW,WAChB,SACA,OAAO,WAAW,YAChB,iBACA,OAAO,OAAO,cAAc;AACpC,QAAI,SAAS,YAAY,KAAK,iBAAiB,MAAM;AACnD,YAAM,IAAI,MAAM,iBAAiB,OAAO,iBAAiB,YAAY;AAAA,IACvE;AAAA,EACF;AAEA,SAAO;AACT;;;AC3BA,SAAS,eAAe;AASjB,IAAM,cAAc,CAAI,OAAY,YAAiC;AAC1E,MAAI,QAAQ,KAAK,GAAG;AAClB,WAAO,QAAQ,KAAK;AAAA,EACtB,OAAO;AACL,UAAM;AAAA,EACR;AACF;AASO,IAAM,mBAAmB,OAAU,OAAY,YAA0C;AAC9F,MAAI,QAAQ,KAAK,GAAG;AAClB,WAAO,MAAM,QAAQ,KAAK;AAAA,EAC5B,OAAO;AACL,UAAM;AAAA,EACR;AACF;;;AC5BA,SAAS,WAAAA,gBAAe;","names":["isError"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/error",
-  "version": "5.0.83",
+  "version": "5.0.86",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "error",
@@ -42,11 +42,11 @@
     "!**/*.test.*"
   ],
   "dependencies": {
-    "@xylabs/typeof": "~5.0.83"
+    "@xylabs/typeof": "~5.0.86"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "~7.4.11",
-    "@xylabs/tsconfig": "~7.4.11",
+    "@xylabs/ts-scripts-yarn3": "~7.4.16",
+    "@xylabs/tsconfig": "~7.4.16",
     "typescript": "~5.9.3",
     "vitest": "^4.0.18"
   },