@xylabs/error 5.0.80 → 5.0.81

package/README.md

@@ -21,14 +21,50 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
 ***
 
+## Type Aliases
+
+- [AssertConfig](#type-aliases/AssertConfig)
+
 ## Functions
 
+- [assertError](#functions/assertError)
 - [handleError](#functions/handleError)
 - [handleErrorAsync](#functions/handleErrorAsync)
 - [isError](#functions/isError)
 
 ### functions
 
+  ### <a id="assertError"></a>assertError
+
+[**@xylabs/error**](#../README)
+
+***
+
+```ts
+function assertError(
+   value, 
+   assert, 
+   defaultMessage): undefined;
+```
+
+## Parameters
+
+### value
+
+`unknown`
+
+### assert
+
+[`AssertConfig`](#../type-aliases/AssertConfig) | `undefined`
+
+### defaultMessage
+
+`string`
+
+## Returns
+
+`undefined`
+
   ### <a id="handleError"></a>handleError
 
 [**@xylabs/error**](#../README)
@@ -95,19 +131,55 @@ function handleErrorAsync<T>(error, handler): Promise<T>;
 
 ***
 
+## Call Signature
+
 ```ts
-function isError(error): error is Error;
+function isError(value): value is Error;
 ```
 
-## Parameters
+### Parameters
 
-### error
+### value
 
-`any`
+`unknown`
 
-## Returns
+### Returns
+
+`value is Error`
+
+## Call Signature
+
+```ts
+function isError<T>(value): value is Extract<T, Error>;
+```
+
+### Type Parameters
+
+### T
+
+`T`
+
+### Parameters
+
+### value
 
-`error is Error`
+`T`
+
+### Returns
+
+`value is Extract<T, Error>`
+
+### type-aliases
+
+  ### <a id="AssertConfig"></a>AssertConfig
+
+[**@xylabs/error**](#../README)
+
+***
+
+```ts
+type AssertConfig = string | AssertCallback | boolean;
+```
 
 
 Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/error",
-  "version": "5.0.80",
+  "version": "5.0.81",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "error",
@@ -29,28 +29,26 @@
   "exports": {
     ".": {
       "types": "./dist/neutral/index.d.ts",
-      "source": "./src/index.ts",
       "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
   "module": "./dist/neutral/index.mjs",
-  "source": "./src/index.ts",
   "types": "./dist/neutral/index.d.ts",
   "files": [
     "dist",
-    "src",
     "!**/*.bench.*",
     "!**/*.spec.*",
     "!**/*.test.*"
   ],
   "dependencies": {
-    "@xylabs/typeof": "~5.0.80"
+    "@xylabs/typeof": "~5.0.81"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "~7.3.2",
-    "@xylabs/tsconfig": "~7.3.2",
-    "typescript": "~5.9.3"
+    "@xylabs/ts-scripts-yarn3": "~7.4.11",
+    "@xylabs/tsconfig": "~7.4.11",
+    "typescript": "~5.9.3",
+    "vitest": "^4.0.18"
   },
   "engines": {
     "node": ">=18"

package/src/assert.ts

@@ -1,21 +0,0 @@
-import { isString, isUndefined } from '@xylabs/typeof'
-
-type AssertCallback = (value: unknown, message: string) => string | boolean
-
-export type AssertConfig = string | AssertCallback | boolean
-
-export const assertError = (value: unknown, assert: AssertConfig | undefined, defaultMessage: string) => {
-  if (!isUndefined(assert)) {
-    const assertString
-      = typeof assert === 'string'
-        ? assert
-        : typeof assert === 'boolean'
-          ? defaultMessage
-          : assert(value, defaultMessage)
-    if (isString(assertString) || assertString === true) {
-      throw new Error(assertString === true ? defaultMessage : assertString)
-    }
-  }
-  // eslint-disable-next-line unicorn/no-useless-undefined
-  return undefined
-}

package/src/handleError.ts

@@ -1,19 +0,0 @@
-import { isError } from '@xylabs/typeof'
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export const handleError = <T>(error: any, handler: (error: Error) => T) => {
-  if (isError(error)) {
-    return handler(error)
-  } else {
-    throw error
-  }
-}
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export const handleErrorAsync = async <T>(error: any, handler: (error: Error) => Promise<T>) => {
-  if (isError(error)) {
-    return await handler(error)
-  } else {
-    throw error
-  }
-}

package/src/index.ts

@@ -1,3 +0,0 @@
-export * from './assert.ts'
-export * from './handleError.ts'
-export { isError } from '@xylabs/typeof'