@twin.org/web 0.0.1-next.3 → 0.0.1-next.5

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/docs/changelog.md CHANGED
@@ -1,5 +1,5 @@
1
1
  # @twin.org/web - Changelog
2
2
 
3
- ## 0.0.1-next.3
3
+ ## 0.0.1-next.5
4
4
 
5
5
  - Initial Release
@@ -46,334 +46,8 @@ The inner error if we have wrapped another error.
46
46
 
47
47
  ## Properties
48
48
 
49
- ### source?
50
-
51
- > `optional` **source**: `string`
52
-
53
- The source of the error.
54
-
55
- #### Inherited from
56
-
57
- `BaseError.source`
58
-
59
- ***
60
-
61
- ### properties?
62
-
63
- > `optional` **properties**: `object`
64
-
65
- Any additional information for the error.
66
-
67
- #### Index Signature
68
-
69
- \[`id`: `string`\]: `unknown`
70
-
71
- #### Inherited from
72
-
73
- `BaseError.properties`
74
-
75
- ***
76
-
77
- ### inner?
78
-
79
- > `optional` **inner**: `IError`
80
-
81
- The inner error if there was one.
82
-
83
- #### Inherited from
84
-
85
- `BaseError.inner`
86
-
87
- ***
88
-
89
49
  ### CLASS\_NAME
90
50
 
91
51
  > `readonly` `static` **CLASS\_NAME**: `string`
92
52
 
93
53
  Runtime name for the class.
94
-
95
- ## Methods
96
-
97
- ### fromError()
98
-
99
- > `static` **fromError**(`err`): `BaseError`
100
-
101
- Construct an error from an existing one.
102
-
103
- #### Parameters
104
-
105
- • **err**: `unknown`
106
-
107
- The existing error.
108
-
109
- #### Returns
110
-
111
- `BaseError`
112
-
113
- The new instance.
114
-
115
- #### Inherited from
116
-
117
- `BaseError.fromError`
118
-
119
- ***
120
-
121
- ### flatten()
122
-
123
- > `static` **flatten**(`err`): `IError`[]
124
-
125
- Flatten an error tree.
126
-
127
- #### Parameters
128
-
129
- • **err**: `unknown`
130
-
131
- The starting error.
132
-
133
- #### Returns
134
-
135
- `IError`[]
136
-
137
- The list of all internal errors.
138
-
139
- #### Inherited from
140
-
141
- `BaseError.flatten`
142
-
143
- ***
144
-
145
- ### expand()
146
-
147
- > `static` **expand**(`errors`): `undefined` \| `IError`
148
-
149
- Expand an error tree.
150
-
151
- #### Parameters
152
-
153
- • **errors**: `undefined` \| `IError`[]
154
-
155
- The list of errors to expand.
156
-
157
- #### Returns
158
-
159
- `undefined` \| `IError`
160
-
161
- The first level error.
162
-
163
- #### Inherited from
164
-
165
- `BaseError.expand`
166
-
167
- ***
168
-
169
- ### isErrorName()
170
-
171
- > `static` **isErrorName**(`error`, `name`): `error is BaseError`
172
-
173
- Test to see if the error has the specified error name.
174
-
175
- #### Parameters
176
-
177
- • **error**: `unknown`
178
-
179
- The error to test.
180
-
181
- • **name**: `string` \| `RegExp`
182
-
183
- The name to check for.
184
-
185
- #### Returns
186
-
187
- `error is BaseError`
188
-
189
- True if the error has the name.
190
-
191
- #### Inherited from
192
-
193
- `BaseError.isErrorName`
194
-
195
- ***
196
-
197
- ### isErrorMessage()
198
-
199
- > `static` **isErrorMessage**(`error`, `message`): `error is BaseError`
200
-
201
- Test to see if the error has the specified error message.
202
-
203
- #### Parameters
204
-
205
- • **error**: `unknown`
206
-
207
- The error to test.
208
-
209
- • **message**: `string` \| `RegExp`
210
-
211
- The message to check for.
212
-
213
- #### Returns
214
-
215
- `error is BaseError`
216
-
217
- True if the error has the name.
218
-
219
- #### Inherited from
220
-
221
- `BaseError.isErrorMessage`
222
-
223
- ***
224
-
225
- ### isErrorCode()
226
-
227
- > `static` **isErrorCode**(`error`, `code`): `boolean`
228
-
229
- Test to see if the error has the specified error code.
230
-
231
- #### Parameters
232
-
233
- • **error**: `unknown`
234
-
235
- The error to test.
236
-
237
- • **code**: `string` \| `RegExp`
238
-
239
- The code to check for.
240
-
241
- #### Returns
242
-
243
- `boolean`
244
-
245
- True if the error has the code.
246
-
247
- #### Inherited from
248
-
249
- `BaseError.isErrorCode`
250
-
251
- ***
252
-
253
- ### someErrorName()
254
-
255
- > `static` **someErrorName**(`error`, `name`): `error is BaseError`
256
-
257
- Test to see if any of the errors or children have the given error name.
258
-
259
- #### Parameters
260
-
261
- • **error**: `unknown`
262
-
263
- The error to test.
264
-
265
- • **name**: `string` \| `RegExp`
266
-
267
- The name to check for.
268
-
269
- #### Returns
270
-
271
- `error is BaseError`
272
-
273
- True if the error has the name.
274
-
275
- #### Inherited from
276
-
277
- `BaseError.someErrorName`
278
-
279
- ***
280
-
281
- ### someErrorMessage()
282
-
283
- > `static` **someErrorMessage**(`error`, `message`): `error is BaseError`
284
-
285
- Test to see if any of the errors or children have the given error message.
286
-
287
- #### Parameters
288
-
289
- • **error**: `unknown`
290
-
291
- The error to test.
292
-
293
- • **message**: `string` \| `RegExp`
294
-
295
- The message to check for.
296
-
297
- #### Returns
298
-
299
- `error is BaseError`
300
-
301
- True if the error has the name.
302
-
303
- #### Inherited from
304
-
305
- `BaseError.someErrorMessage`
306
-
307
- ***
308
-
309
- ### someErrorClass()
310
-
311
- > `static` **someErrorClass**(`error`, `cls`): `error is BaseError`
312
-
313
- Test to see if any of the errors or children are from a specific class.
314
-
315
- #### Parameters
316
-
317
- • **error**: `unknown`
318
-
319
- The error to test.
320
-
321
- • **cls**: `string`
322
-
323
- The class to check for.
324
-
325
- #### Returns
326
-
327
- `error is BaseError`
328
-
329
- True if the error has the specific class.
330
-
331
- #### Inherited from
332
-
333
- `BaseError.someErrorClass`
334
-
335
- ***
336
-
337
- ### someErrorCode()
338
-
339
- > `static` **someErrorCode**(`error`, `code`): `error is BaseError`
340
-
341
- Test to see if any of the errors or children have the given error code.
342
-
343
- #### Parameters
344
-
345
- • **error**: `unknown`
346
-
347
- The error to test.
348
-
349
- • **code**: `string` \| `RegExp`
350
-
351
- The code to check for.
352
-
353
- #### Returns
354
-
355
- `error is BaseError`
356
-
357
- True if the error has the name.
358
-
359
- #### Inherited from
360
-
361
- `BaseError.someErrorCode`
362
-
363
- ***
364
-
365
- ### toJsonObject()
366
-
367
- > **toJsonObject**(): `IError`
368
-
369
- Serialize the error to the error model.
370
-
371
- #### Returns
372
-
373
- `IError`
374
-
375
- The error model.
376
-
377
- #### Inherited from
378
-
379
- `BaseError.toJsonObject`
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/web",
3
- "version": "0.0.1-next.3",
3
+ "version": "0.0.1-next.5",
4
4
  "description": "Contains classes for use with web operations",
5
5
  "repository": {
6
6
  "type": "git",
@@ -13,38 +13,11 @@
13
13
  "engines": {
14
14
  "node": ">=20.0.0"
15
15
  },
16
- "scripts": {
17
- "clean": "rimraf dist coverage",
18
- "build": "tspc",
19
- "test": "vitest --run --config ./vitest.config.ts --no-cache",
20
- "coverage": "vitest --run --coverage --config ./vitest.config.ts --no-cache",
21
- "bundle:esm": "rollup --config rollup.config.mjs --environment MODULE:esm",
22
- "bundle:cjs": "rollup --config rollup.config.mjs --environment MODULE:cjs",
23
- "bundle": "npm run bundle:esm && npm run bundle:cjs",
24
- "docs:clean": "rimraf docs/reference",
25
- "docs:generate": "typedoc",
26
- "docs": "npm run docs:clean && npm run docs:generate",
27
- "dist": "npm run clean && npm run build && npm run test && npm run bundle && npm run docs"
28
- },
29
16
  "dependencies": {
30
- "@twin.org/core": "0.0.1-next.3",
31
- "@twin.org/crypto": "0.0.1-next.3",
17
+ "@twin.org/core": "0.0.1-next.5",
18
+ "@twin.org/crypto": "0.0.1-next.5",
32
19
  "@twin.org/nameof": "next"
33
20
  },
34
- "devDependencies": {
35
- "@twin.org/nameof-transformer": "next",
36
- "@types/node": "22.5.5",
37
- "@vitest/coverage-v8": "2.1.1",
38
- "copyfiles": "2.4.1",
39
- "rimraf": "6.0.1",
40
- "rollup": "4.21.3",
41
- "rollup-plugin-typescript2": "0.36.0",
42
- "ts-patch": "3.2.1",
43
- "typedoc": "0.26.7",
44
- "typedoc-plugin-markdown": "4.2.7",
45
- "typescript": "5.6.2",
46
- "vitest": "2.1.1"
47
- },
48
21
  "main": "./dist/cjs/index.cjs",
49
22
  "module": "./dist/esm/index.mjs",
50
23
  "types": "./dist/types/index.d.ts",