@xylabs/error 5.0.80 → 5.0.82

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.
package/README.md CHANGED
@@ -21,14 +21,50 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
21
21
 
22
22
  ***
23
23
 
24
+ ## Type Aliases
25
+
26
+ - [AssertConfig](#type-aliases/AssertConfig)
27
+
24
28
  ## Functions
25
29
 
30
+ - [assertError](#functions/assertError)
26
31
  - [handleError](#functions/handleError)
27
32
  - [handleErrorAsync](#functions/handleErrorAsync)
28
33
  - [isError](#functions/isError)
29
34
 
30
35
  ### functions
31
36
 
37
+ ### <a id="assertError"></a>assertError
38
+
39
+ [**@xylabs/error**](#../README)
40
+
41
+ ***
42
+
43
+ ```ts
44
+ function assertError(
45
+ value,
46
+ assert,
47
+ defaultMessage): undefined;
48
+ ```
49
+
50
+ ## Parameters
51
+
52
+ ### value
53
+
54
+ `unknown`
55
+
56
+ ### assert
57
+
58
+ [`AssertConfig`](#../type-aliases/AssertConfig) | `undefined`
59
+
60
+ ### defaultMessage
61
+
62
+ `string`
63
+
64
+ ## Returns
65
+
66
+ `undefined`
67
+
32
68
  ### <a id="handleError"></a>handleError
33
69
 
34
70
  [**@xylabs/error**](#../README)
@@ -95,19 +131,55 @@ function handleErrorAsync<T>(error, handler): Promise<T>;
95
131
 
96
132
  ***
97
133
 
134
+ ## Call Signature
135
+
98
136
  ```ts
99
- function isError(error): error is Error;
137
+ function isError(value): value is Error;
100
138
  ```
101
139
 
102
- ## Parameters
140
+ ### Parameters
103
141
 
104
- ### error
142
+ ### value
105
143
 
106
- `any`
144
+ `unknown`
107
145
 
108
- ## Returns
146
+ ### Returns
147
+
148
+ `value is Error`
149
+
150
+ ## Call Signature
151
+
152
+ ```ts
153
+ function isError<T>(value): value is Extract<T, Error>;
154
+ ```
155
+
156
+ ### Type Parameters
157
+
158
+ ### T
159
+
160
+ `T`
161
+
162
+ ### Parameters
163
+
164
+ ### value
109
165
 
110
- `error is Error`
166
+ `T`
167
+
168
+ ### Returns
169
+
170
+ `value is Extract<T, Error>`
171
+
172
+ ### type-aliases
173
+
174
+ ### <a id="AssertConfig"></a>AssertConfig
175
+
176
+ [**@xylabs/error**](#../README)
177
+
178
+ ***
179
+
180
+ ```ts
181
+ type AssertConfig = string | AssertCallback | boolean;
182
+ ```
111
183
 
112
184
 
113
185
  Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xylabs/error",
3
- "version": "5.0.80",
3
+ "version": "5.0.82",
4
4
  "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
5
5
  "keywords": [
6
6
  "error",
@@ -29,28 +29,26 @@
29
29
  "exports": {
30
30
  ".": {
31
31
  "types": "./dist/neutral/index.d.ts",
32
- "source": "./src/index.ts",
33
32
  "default": "./dist/neutral/index.mjs"
34
33
  },
35
34
  "./package.json": "./package.json"
36
35
  },
37
36
  "module": "./dist/neutral/index.mjs",
38
- "source": "./src/index.ts",
39
37
  "types": "./dist/neutral/index.d.ts",
40
38
  "files": [
41
39
  "dist",
42
- "src",
43
40
  "!**/*.bench.*",
44
41
  "!**/*.spec.*",
45
42
  "!**/*.test.*"
46
43
  ],
47
44
  "dependencies": {
48
- "@xylabs/typeof": "~5.0.80"
45
+ "@xylabs/typeof": "~5.0.82"
49
46
  },
50
47
  "devDependencies": {
51
- "@xylabs/ts-scripts-yarn3": "~7.3.2",
52
- "@xylabs/tsconfig": "~7.3.2",
53
- "typescript": "~5.9.3"
48
+ "@xylabs/ts-scripts-yarn3": "~7.4.11",
49
+ "@xylabs/tsconfig": "~7.4.11",
50
+ "typescript": "~5.9.3",
51
+ "vitest": "^4.0.18"
54
52
  },
55
53
  "engines": {
56
54
  "node": ">=18"
package/src/assert.ts DELETED
@@ -1,21 +0,0 @@
1
- import { isString, isUndefined } from '@xylabs/typeof'
2
-
3
- type AssertCallback = (value: unknown, message: string) => string | boolean
4
-
5
- export type AssertConfig = string | AssertCallback | boolean
6
-
7
- export const assertError = (value: unknown, assert: AssertConfig | undefined, defaultMessage: string) => {
8
- if (!isUndefined(assert)) {
9
- const assertString
10
- = typeof assert === 'string'
11
- ? assert
12
- : typeof assert === 'boolean'
13
- ? defaultMessage
14
- : assert(value, defaultMessage)
15
- if (isString(assertString) || assertString === true) {
16
- throw new Error(assertString === true ? defaultMessage : assertString)
17
- }
18
- }
19
- // eslint-disable-next-line unicorn/no-useless-undefined
20
- return undefined
21
- }
@@ -1,19 +0,0 @@
1
- import { isError } from '@xylabs/typeof'
2
-
3
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
4
- export const handleError = <T>(error: any, handler: (error: Error) => T) => {
5
- if (isError(error)) {
6
- return handler(error)
7
- } else {
8
- throw error
9
- }
10
- }
11
-
12
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
13
- export const handleErrorAsync = async <T>(error: any, handler: (error: Error) => Promise<T>) => {
14
- if (isError(error)) {
15
- return await handler(error)
16
- } else {
17
- throw error
18
- }
19
- }
package/src/index.ts DELETED
@@ -1,3 +0,0 @@
1
- export * from './assert.ts'
2
- export * from './handleError.ts'
3
- export { isError } from '@xylabs/typeof'