@xylabs/error 5.0.95 → 5.0.97

package/README.md

@@ -1,46 +1,52 @@
 # @xylabs/error
 
-[![logo][]](https://xylabs.com)
+[![npm][npm-badge]][npm-link]
+[![license][license-badge]][license-link]
 
-[![main-build][]][main-build-link]
-[![npm-badge][]][npm-link]
-[![npm-downloads-badge][]][npm-link]
-[![jsdelivr-badge][]][jsdelivr-link]
-[![npm-license-badge][]](LICENSE)
-[![codacy-badge][]][codacy-link]
-[![codeclimate-badge][]][codeclimate-link]
-[![snyk-badge][]][snyk-link]
-[![socket-badge][]][socket-link]
+> Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
+## Install
 
-Base functionality used throughout XY Labs TypeScript/JavaScript libraries
+Using npm:
 
+```sh
+npm install {{name}}
+```
 
+Using yarn:
 
-## Reference
+```sh
+yarn add {{name}}
+```
 
-**@xylabs/error**
+Using pnpm:
 
-***
+```sh
+pnpm add {{name}}
+```
+
+Using bun:
+
+```sh
+bun add {{name}}
+```
 
-## Type Aliases
 
-| Type Alias | Description |
-| ------ | ------ |
-| [AssertConfig](#type-aliases/AssertConfig) | Configuration for assertion behavior: a static message string, a boolean toggle, or a callback. |
+## License
+
+See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
+
+## Reference
 
-## Functions
+### packages
 
-| 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. |
+  ### error
 
-### functions
+    ### .temp-typedoc
 
-  ### <a id="assertError"></a>assertError
+      ### functions
+
+        ### <a id="assertError"></a>assertError
 
 [**@xylabs/error**](#../README)
 
@@ -48,138 +54,116 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
 ```ts
 function assertError(
-   value: unknown, 
-   assert: AssertConfig | undefined, 
-   defaultMessage: string): undefined;
+   value, 
+   assert, 
+   defaultMessage): undefined;
 ```
 
 Throws an Error based on the assert configuration when a value fails validation.
 
 ## Parameters
 
-| 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
-
-`undefined`
-
-  ### <a id="handleError"></a>handleError
+### value
 
-[**@xylabs/error**](#../README)
+`unknown`
 
-***
+The value being validated
 
-```ts
-function handleError<T>(error: any, handler: (error: Error) => T): T;
-```
+### assert
 
-Invokes the handler if the value is an Error, otherwise re-throws it.
+[`AssertConfig`](#../type-aliases/AssertConfig) \| `undefined`
 
-## Type Parameters
+Assertion config controlling the error message
 
-| Type Parameter |
-| ------ |
-| `T` |
+### defaultMessage
 
-## Parameters
+`string`
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `error` | `any` | The caught value to inspect |
-| `handler` | (`error`: `Error`) => `T` | Callback invoked with the Error if it is one |
+Fallback message if no custom message is provided
 
 ## Returns
 
-`T`
-
-The handler's return value
+`undefined`
 
-  ### <a id="handleErrorAsync"></a>handleErrorAsync
+        ### <a id="handleError"></a>handleError
 
 [**@xylabs/error**](#../README)
 
 ***
 
 ```ts
-function handleErrorAsync<T>(error: any, handler: (error: Error) => Promise<T>): Promise<T>;
+function handleError<T>(error, handler): T;
 ```
 
-Async version of handleError. Invokes the async handler if the value is an Error, otherwise re-throws it.
+Invokes the handler if the value is an Error, otherwise re-throws it.
 
 ## Type Parameters
 
-| Type Parameter |
-| ------ |
-| `T` |
+### T
+
+`T`
 
 ## Parameters
 
-| 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 |
+### error
+
+`any`
+
+The caught value to inspect
+
+### handler
+
+(`error`) => `T`
+
+Callback invoked with the Error if it is one
 
 ## Returns
 
-`Promise`\<`T`\>
+`T`
 
-The handler's resolved return value
+The handler's return value
 
-  ### <a id="isError"></a>isError
+        ### <a id="handleErrorAsync"></a>handleErrorAsync
 
 [**@xylabs/error**](#../README)
 
 ***
 
-## Call Signature
-
 ```ts
-function isError(value: unknown): value is Error;
+function handleErrorAsync<T>(error, handler): Promise<T>;
 ```
 
-Type guard that checks whether a value is an Error instance.
+Async version of handleError. Invokes the async handler if the value is an Error, otherwise re-throws it.
 
-### Parameters
+## Type Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `value` | `unknown` |
+### T
 
-### Returns
+`T`
 
-`value is Error`
+## Parameters
 
-## Call Signature
+### error
 
-```ts
-function isError<T>(value: T): value is Extract<T, Error>;
-```
+`any`
 
-Type guard that checks whether a value is an Error instance.
+The caught value to inspect
 
-### Type Parameters
+### handler
 
-| Type Parameter |
-| ------ |
-| `T` |
+(`error`) => `Promise`\<`T`\>
 
-### Parameters
+Async callback invoked with the Error if it is one
 
-| Parameter | Type |
-| ------ | ------ |
-| `value` | `T` |
+## Returns
 
-### Returns
+`Promise`\<`T`\>
 
-`value is Extract<T, Error>`
+The handler's resolved return value
 
-### type-aliases
+      ### type-aliases
 
-  ### <a id="AssertConfig"></a>AssertConfig
+        ### <a id="AssertConfig"></a>AssertConfig
 
 [**@xylabs/error**](#../README)
 
@@ -192,41 +176,7 @@ 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)
-
-## Maintainers
-
--   [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
--   [Matt Jones](https://github.com/jonesmac)
--   [Joel Carter](https://github.com/JoelBCarter)
--   [Jordan Trouw](https://github.com/jordantrouw)
-
-## License
-
-> See the [LICENSE](LICENSE) file for license details
-
-## Credits
-
-[Made with 🔥 and ❄️ by XYLabs](https://xylabs.com)
-
-[logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg
-
-[main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml/badge.svg
-[main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml
 [npm-badge]: https://img.shields.io/npm/v/@xylabs/error.svg
 [npm-link]: https://www.npmjs.com/package/@xylabs/error
-[codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698
-[codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-js&utm_campaign=Badge_Grade
-[codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability
-[codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-js/maintainability
-[snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json
-[snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json
-
-[npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/error
-[npm-license-badge]: https://img.shields.io/npm/l/@xylabs/error
-
-[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xylabs/error/badge
-[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/error
-
-[socket-badge]: https://socket.dev/api/badge/npm/package/@xylabs/error
-[socket-link]: https://socket.dev/npm/package/@xylabs/error
+[license-badge]: https://img.shields.io/npm/l/@xylabs/error.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE

package/dist/neutral/index.d.ts

@@ -1,4 +1,3 @@
 export * from './assert.ts';
 export * from './handleError.ts';
-export { isError } from '@xylabs/typeof';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,kBAAkB,CAAA;AAChC,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,kBAAkB,CAAA"}

package/dist/neutral/index.mjs

@@ -26,13 +26,9 @@ var handleErrorAsync = async (error, handler) => {
     throw error;
   }
 };
-
-// src/index.ts
-import { isError as isError2 } from "@xylabs/typeof";
 export {
   assertError,
   handleError,
-  handleErrorAsync,
-  isError2 as isError
+  handleErrorAsync
 };
 //# sourceMappingURL=index.mjs.map

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\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"]}
+{"version":3,"sources":["../../src/assert.ts","../../src/handleError.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"],"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;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/error",
-  "version": "5.0.95",
+  "version": "5.0.97",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "error",
@@ -29,12 +29,10 @@
   "exports": {
     ".": {
       "types": "./dist/neutral/index.d.ts",
-      "import": "./dist/neutral/index.mjs",
       "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
-  "types": "./dist/neutral/index.d.ts",
   "files": [
     "dist",
     "!**/*.bench.*",
@@ -43,17 +41,16 @@
     "README.md"
   ],
   "dependencies": {
-    "@xylabs/typeof": "~5.0.95"
+    "@xylabs/typeof": "~5.0.97"
   },
   "devDependencies": {
-    "@types/node": "^25.5.2",
-    "@xylabs/ts-scripts-common": "~7.8.4",
-    "@xylabs/ts-scripts-pnpm": "~7.8.4",
-    "@xylabs/tsconfig": "~7.8.4",
+    "@types/node": "^25.6.0",
+    "@xylabs/toolchain": "~7.10.4",
+    "@xylabs/tsconfig": "~7.10.4",
     "esbuild": "^0.28.0",
     "typescript": "^5",
-    "vite": "^8.0.5",
-    "vitest": "^4.1.2"
+    "vite": "^8.0.8",
+    "vitest": "^4.1.4"
   },
   "engines": {
     "node": ">=18"