@isdk/ai-tool 0.2.0 → 0.2.2

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.
Files changed (248) hide show
  1. package/dist/chunk-PY6NRGZE.mjs +1 -0
  2. package/dist/funcs.d.mts +1 -1
  3. package/dist/funcs.d.ts +1 -1
  4. package/dist/funcs.js +1 -1
  5. package/dist/funcs.mjs +1 -1
  6. package/dist/{index-nP9lSU6E.d.mts → index-DUEs7T8M.d.mts} +2 -2
  7. package/dist/{index-nP9lSU6E.d.ts → index-DUEs7T8M.d.ts} +2 -2
  8. package/dist/index.d.mts +5 -4
  9. package/dist/index.d.ts +5 -4
  10. package/dist/index.js +1 -1
  11. package/dist/index.mjs +1 -1
  12. package/docs/README.md +5 -3
  13. package/docs/_media/CONTRIBUTING.md +18 -0
  14. package/docs/_media/LICENSE-MIT +22 -0
  15. package/docs/classes/AbortError.md +108 -129
  16. package/docs/classes/AlreadyExistsError.md +105 -126
  17. package/docs/classes/BaseError.md +112 -125
  18. package/docs/classes/CancelableAbility.md +136 -188
  19. package/docs/classes/ClientTools.md +1005 -1107
  20. package/docs/classes/CommonError.md +115 -136
  21. package/docs/classes/ConfigFile.md +150 -163
  22. package/docs/classes/EventClient.md +1128 -1282
  23. package/docs/classes/EventServer.md +1165 -1303
  24. package/docs/classes/EventToolFunc.md +958 -1028
  25. package/docs/classes/FStringPromptTemplate.md +352 -438
  26. package/docs/classes/FewShotPromptTemplate.md +364 -464
  27. package/docs/classes/GolangPromptTemplate.md +352 -438
  28. package/docs/classes/HFEnvironment.md +53 -79
  29. package/docs/classes/HFInterpreter.md +20 -377
  30. package/docs/classes/HFTemplate.md +21 -33
  31. package/docs/classes/HfPromptTemplate.md +352 -438
  32. package/docs/classes/IntSet.md +67 -100
  33. package/docs/classes/NotFoundError.md +105 -126
  34. package/docs/classes/NotImplementationError.md +105 -126
  35. package/docs/classes/PromptExampleSelector.md +58 -70
  36. package/docs/classes/PromptTemplate.md +338 -422
  37. package/docs/classes/ReadableStreamError.md +108 -129
  38. package/docs/classes/ResClientTools.md +916 -1026
  39. package/docs/classes/ResServerTools.md +919 -1026
  40. package/docs/classes/SSEChannel.md +93 -112
  41. package/docs/classes/Semaphore.md +44 -140
  42. package/docs/classes/ServerTools.md +981 -1072
  43. package/docs/classes/TaskAbortController.md +46 -66
  44. package/docs/classes/ToolFunc.md +840 -910
  45. package/docs/enumerations/AsyncFeatureBits.md +37 -0
  46. package/docs/enumerations/AsyncFeatures.md +37 -0
  47. package/docs/enumerations/ErrorCode.md +217 -0
  48. package/docs/enumerations/XXHashAlgorithm.md +27 -0
  49. package/docs/functions/AIArgProcessor.md +27 -0
  50. package/docs/functions/AIStream.md +50 -0
  51. package/docs/functions/ChoiceArgProcessor.md +27 -0
  52. package/docs/functions/RateLimit.md +33 -0
  53. package/docs/functions/TemplateArgProcessor.md +27 -0
  54. package/docs/functions/backendEventable.md +23 -0
  55. package/docs/functions/canonicalize.md +21 -0
  56. package/docs/functions/countRegexMatches.md +33 -0
  57. package/docs/functions/createAbilityInjector.md +87 -0
  58. package/docs/functions/createCallbacksTransformer.md +49 -0
  59. package/docs/functions/createEmptyReadableStream.md +23 -0
  60. package/docs/functions/createEndWithRepetitionDetector.md +29 -0
  61. package/docs/functions/createError.md +35 -0
  62. package/docs/functions/createEventStreamTransformer.md +33 -0
  63. package/docs/functions/createHfValueFunc.md +29 -0
  64. package/docs/functions/createLRUCache.md +23 -0
  65. package/docs/functions/dateToText.md +23 -0
  66. package/docs/functions/expandEnv.md +40 -0
  67. package/docs/functions/expandObjEnv.md +54 -0
  68. package/docs/functions/extNameLevel.md +43 -0
  69. package/docs/functions/fileIsExists.md +34 -0
  70. package/docs/functions/filenameReservedRegex.md +22 -0
  71. package/docs/functions/filterValidFnScope.md +21 -0
  72. package/docs/functions/findPort.md +23 -0
  73. package/docs/functions/formatISO.md +71 -0
  74. package/docs/functions/getAllEnumKeys.md +31 -0
  75. package/docs/functions/getConfigFileNames.md +23 -0
  76. package/docs/functions/getConfigs.md +23 -0
  77. package/docs/functions/getKeysPath.md +38 -0
  78. package/docs/functions/getMultiLevelExtname.md +31 -0
  79. package/docs/functions/getPackageDir.md +39 -0
  80. package/docs/functions/getRealFilepath.md +34 -0
  81. package/docs/functions/getResponseErrorReadableStream.md +21 -0
  82. package/docs/functions/hfParse.md +24 -0
  83. package/docs/functions/hfTokenize.md +25 -0
  84. package/docs/functions/interpolateEnv.md +25 -0
  85. package/docs/functions/interpolateFString.md +27 -0
  86. package/docs/functions/interpolateGolangTemplate.md +31 -0
  87. package/docs/functions/isModelNameMatched.md +45 -0
  88. package/docs/functions/isValidFilename.md +38 -0
  89. package/docs/functions/isValidFilepath.md +27 -0
  90. package/docs/functions/isWebStream.md +21 -0
  91. package/docs/functions/jsonFilterToWhere.md +45 -0
  92. package/docs/functions/jsonToMarkdownStr.md +31 -0
  93. package/docs/functions/loadFileFromPaths.md +54 -0
  94. package/docs/functions/loadTextFromPaths.md +29 -0
  95. package/docs/functions/lrucache.md +29 -0
  96. package/docs/functions/makeToolFuncCancelable.md +23 -0
  97. package/docs/functions/matchUrlProtocol.md +48 -0
  98. package/docs/functions/memoize.md +27 -0
  99. package/docs/functions/messagesToText.md +21 -0
  100. package/docs/functions/paramsSizeToScaleStr.md +32 -0
  101. package/docs/functions/parseCommand.md +33 -0
  102. package/docs/functions/parseDateFormat.md +360 -0
  103. package/docs/functions/parseFString.md +26 -0
  104. package/docs/functions/parseISO.md +72 -0
  105. package/docs/functions/parseJsJson.md +38 -0
  106. package/docs/functions/parseObjectArgInfo.md +27 -0
  107. package/docs/functions/parseObjectArgumentInfos.md +25 -0
  108. package/docs/functions/parseObjectArguments.md +68 -0
  109. package/docs/functions/parseObjectArgumentsAsArgInfos.md +42 -0
  110. package/docs/functions/parseYaml.md +21 -0
  111. package/docs/functions/quoteStr.md +21 -0
  112. package/docs/functions/reControlCharsRegex.md +21 -0
  113. package/docs/functions/readFilenamesRecursiveSync.md +47 -0
  114. package/docs/functions/readableFromAsyncIterable.md +28 -0
  115. package/docs/functions/registerCoreTools.md +17 -0
  116. package/docs/functions/registerYamlTag.md +21 -0
  117. package/docs/functions/sanitizeFilename.md +37 -0
  118. package/docs/functions/sanitizeFilepath.md +31 -0
  119. package/docs/functions/saveConfigFile.md +25 -0
  120. package/docs/functions/scaleStrToParamsSize.md +27 -0
  121. package/docs/functions/simplifyObjectArguments.md +21 -0
  122. package/docs/functions/sortedValues.md +25 -0
  123. package/docs/functions/splitSentence.md +37 -0
  124. package/docs/functions/stringifyYaml.md +49 -0
  125. package/docs/functions/textToDate.md +23 -0
  126. package/docs/functions/throwError.md +37 -0
  127. package/docs/functions/toDate.md +76 -0
  128. package/docs/functions/toDateTime.md +21 -0
  129. package/docs/functions/trimStartOfStreamHelper.md +41 -0
  130. package/docs/functions/truncTo.md +47 -0
  131. package/docs/functions/uuid.md +23 -0
  132. package/docs/functions/uuidParse.md +21 -0
  133. package/docs/functions/uuidStringify.md +23 -0
  134. package/docs/functions/uuidValidate.md +21 -0
  135. package/docs/functions/uuidVersion.md +21 -0
  136. package/docs/functions/uuidv1.md +47 -0
  137. package/docs/functions/uuidv4.md +47 -0
  138. package/docs/functions/uuidv5.md +51 -0
  139. package/docs/functions/wait.md +21 -0
  140. package/docs/functions/xxhash.md +25 -0
  141. package/docs/functions/xxhash32.md +23 -0
  142. package/docs/functions/xxhash64.md +23 -0
  143. package/docs/functions/xxhashAsStr.md +25 -0
  144. package/docs/globals.md +236 -0
  145. package/docs/interfaces/AIChatAssistantMessageParam.md +29 -38
  146. package/docs/interfaces/AIChatContentPartImage.md +11 -16
  147. package/docs/interfaces/AIChatContentPartText.md +9 -12
  148. package/docs/interfaces/AIChatMessageParamBase.md +12 -19
  149. package/docs/interfaces/AIChatMessageToolCall.md +18 -21
  150. package/docs/interfaces/AIChatSystemMessageParam.md +16 -22
  151. package/docs/interfaces/AIChatToolMessageParam.md +19 -26
  152. package/docs/interfaces/AIChatUserMessageParam.md +32 -42
  153. package/docs/interfaces/AIChoiceConfig.md +31 -39
  154. package/docs/interfaces/AIResult.md +29 -32
  155. package/docs/interfaces/AIStreamParser.md +24 -18
  156. package/docs/interfaces/AIStreamParserOptions.md +8 -10
  157. package/docs/interfaces/BaseFunc.md +55 -75
  158. package/docs/interfaces/BaseFuncItem.md +43 -61
  159. package/docs/interfaces/CancelableAbilityOptions.md +43 -54
  160. package/docs/interfaces/ClientFuncItem.md +66 -83
  161. package/docs/interfaces/DotenvExpandOptions.md +15 -19
  162. package/docs/interfaces/DotenvExpandOutput.md +11 -14
  163. package/docs/interfaces/DotenvParseInput.md +6 -2
  164. package/docs/interfaces/DotenvParseOutput.md +6 -2
  165. package/docs/interfaces/DotenvPopulateInput.md +6 -2
  166. package/docs/interfaces/EventClientFuncParams.md +22 -33
  167. package/docs/interfaces/EventServerFuncParams.md +27 -35
  168. package/docs/interfaces/FewShotPromptTemplateOptions.md +58 -74
  169. package/docs/interfaces/FuncItem.md +53 -70
  170. package/docs/interfaces/FuncParam.md +29 -36
  171. package/docs/interfaces/FuncParams.md +6 -2
  172. package/docs/interfaces/Funcs.md +6 -2
  173. package/docs/interfaces/JsonFilter.md +6 -2
  174. package/docs/interfaces/ParseObjectArgumentOptions.md +23 -29
  175. package/docs/interfaces/PromptExampleSelectorOptions.md +13 -16
  176. package/docs/interfaces/PromptTemplateOptions.md +31 -40
  177. package/docs/interfaces/RemoteFuncItem.md +64 -82
  178. package/docs/interfaces/ResClientFuncParams.md +14 -19
  179. package/docs/interfaces/ResServerFuncParams.md +28 -36
  180. package/docs/interfaces/SanitizeFilenameOptions.md +11 -14
  181. package/docs/interfaces/ServerFuncItem.md +70 -88
  182. package/docs/interfaces/ServerFuncParams.md +15 -20
  183. package/docs/interfaces/StreamCallbacksAndOptions.md +36 -65
  184. package/docs/interfaces/TaskAbortControllers.md +6 -2
  185. package/docs/interfaces/TaskPromise.md +48 -61
  186. package/docs/interfaces/ToolFuncPackage.md +18 -32
  187. package/docs/type-aliases/AIChatContentPart.md +13 -0
  188. package/docs/type-aliases/AIChatMessageParam.md +13 -0
  189. package/docs/type-aliases/AIChatRole.md +13 -0
  190. package/docs/type-aliases/AIMessageType.md +13 -0
  191. package/docs/type-aliases/AIModelNameRule.md +13 -0
  192. package/docs/type-aliases/AIModelNameRuleFn.md +21 -0
  193. package/docs/type-aliases/AIModelNameRules.md +13 -0
  194. package/docs/type-aliases/AITextGenerationFinishReason.md +13 -0
  195. package/docs/type-aliases/ActionName.md +13 -0
  196. package/docs/type-aliases/AsyncTaskId.md +13 -0
  197. package/docs/type-aliases/EventErrorListenerFn.md +27 -0
  198. package/docs/type-aliases/EventListenerFn.md +25 -0
  199. package/docs/type-aliases/FStringPromptTemplateNode.md +16 -0
  200. package/docs/type-aliases/FuncParamType.md +13 -0
  201. package/docs/type-aliases/PromptExamples.md +17 -0
  202. package/docs/type-aliases/PromptTemplateType.md +13 -0
  203. package/docs/type-aliases/PromptType.md +13 -0
  204. package/docs/type-aliases/TFunc.md +23 -0
  205. package/docs/variables/AIChatRoles.md +13 -0
  206. package/docs/variables/AIMessageTypes.md +13 -0
  207. package/docs/variables/AITextGenerationFinishReasons.md +13 -0
  208. package/docs/variables/AbortErrorCode.md +13 -0
  209. package/docs/variables/ActionNames.md +13 -0
  210. package/docs/variables/AlreadyExistsErrorCode.md +13 -0
  211. package/docs/variables/ClientToolFuncSchema.md +87 -0
  212. package/docs/variables/DefaultAsyncSemaphoreCapacity.md +13 -0
  213. package/docs/variables/EventBusName.md +13 -0
  214. package/docs/variables/EventName.md +13 -0
  215. package/docs/variables/FilenameReservedRegex.md +16 -0
  216. package/docs/variables/HFBuiltins.md +92 -0
  217. package/docs/variables/InternalErrorCode.md +13 -0
  218. package/docs/variables/NotFoundErrorCode.md +13 -0
  219. package/docs/variables/NotImplementedErrorCode.md +13 -0
  220. package/docs/variables/PASSING_SCORE.md +13 -0
  221. package/docs/variables/PromptTemplateTypes.md +13 -0
  222. package/docs/variables/PromptTypes.md +16 -0
  223. package/docs/variables/RStreamErrCode.md +13 -0
  224. package/docs/variables/RemoteToolFuncSchema.md +87 -0
  225. package/docs/variables/ResponseRStreamErrCode.md +13 -0
  226. package/docs/variables/SSEChannelAlreadyClosedErrCode.md +13 -0
  227. package/docs/variables/ServerToolFuncSchema.md +87 -0
  228. package/docs/variables/ToolAsyncCancelableBit.md +13 -0
  229. package/docs/variables/ToolAsyncMultiTaskBit.md +13 -0
  230. package/docs/variables/ToolAsyncPriorityBit.md +13 -0
  231. package/docs/variables/ToolFuncSchema.md +125 -0
  232. package/docs/variables/WindowsReservedNameRegex.md +15 -0
  233. package/docs/variables/base32768.md +13 -0
  234. package/docs/variables/defaultTemplateFormat.md +13 -0
  235. package/docs/variables/event.md +13 -0
  236. package/docs/variables/eventClient.md +13 -0
  237. package/docs/variables/eventServer.md +13 -0
  238. package/docs/variables/lrucache.md +13 -0
  239. package/docs/variables/mimeType.md +13 -0
  240. package/docs/variables/uuidNIL.md +13 -0
  241. package/package.json +26 -27
  242. package/dist/chunk-W2LO3HZT.mjs +0 -1
  243. package/docs/.nojekyll +0 -1
  244. package/docs/enums/AsyncFeatureBits.md +0 -41
  245. package/docs/enums/AsyncFeatures.md +0 -41
  246. package/docs/enums/ErrorCode.md +0 -239
  247. package/docs/enums/XXHashAlgorithm.md +0 -30
  248. package/docs/modules.md +0 -4062
package/docs/classes/AbortError.md CHANGED
@@ -1,10 +1,14 @@
1
- [@isdk/ai-tool](../README.md) / [Exports](../modules.md) / AbortError
1
+ [**@isdk/ai-tool**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / AbortError
2
6
 
3
7
  # Class: AbortError
4
8
 
5
9
  BaseError class that extends the Error class.
6
10
 
7
- **`Example`**
11
+ ## Example
8
12
 
9
13
  ```ts
10
14
  // Create a custom error
@@ -19,62 +23,33 @@ class CustomError extends BaseError {
19
23
  throw new CustomError('This is a custom error');
20
24
  ```
21
25
 
22
- **`Description`**
26
+ ## Description
23
27
 
24
28
  This class is used to create custom errors that extend the built-in Error class. It provides a way to define custom error codes and additional data associated with the error.
25
29
 
26
- **`Method`**
30
+ ## Method
27
31
 
28
32
  toJSON - Returns a JSON representation of the error.
29
33
 
30
- **`Method`**
34
+ ## Method
31
35
 
32
36
  fromJSON - Creates a new BaseError instance from a JSON representation.
33
37
 
34
- ## Hierarchy
38
+ ## Extends
35
39
 
36
40
  - [`CommonError`](CommonError.md)
37
41
 
38
- ↳ **`AbortError`**
39
-
40
- ## Table of contents
41
-
42
- ### Constructors
43
-
44
- - [constructor](AbortError.md#constructor)
45
-
46
- ### Properties
47
-
48
- - [caller](AbortError.md#caller)
49
- - [cause](AbortError.md#cause)
50
- - [code](AbortError.md#code)
51
- - [data](AbortError.md#data)
52
- - [message](AbortError.md#message)
53
- - [name](AbortError.md#name)
54
- - [stack](AbortError.md#stack)
55
- - [code](AbortError.md#code-1)
56
- - [prepareStackTrace](AbortError.md#preparestacktrace)
57
- - [stackTraceLimit](AbortError.md#stacktracelimit)
58
-
59
- ### Methods
60
-
61
- - [fromJSON](AbortError.md#fromjson)
62
- - [toJSON](AbortError.md#tojson)
63
- - [captureStackTrace](AbortError.md#capturestacktrace)
64
- - [createErrorClass](AbortError.md#createerrorclass)
65
-
66
42
  ## Constructors
67
43
 
68
- ### constructor
44
+ ### new AbortError()
69
45
 
70
- • **new AbortError**(`what?`, `name?`): [`AbortError`](AbortError.md)
46
+ > **new AbortError**(`what`?, `name`?): [`AbortError`](AbortError.md)
71
47
 
72
48
  #### Parameters
73
49
 
74
- | Name | Type |
75
- | :------ | :------ |
76
- | `what?` | `string` |
77
- | `name?` | `string` \| `Record`\<`string`, `any`\> |
50
+ • **what?**: `string`
51
+
52
+ • **name?**: `string` \| `Record`\<`string`, `any`\>
78
53
 
79
54
  #### Returns
80
55
 
@@ -82,192 +57,189 @@ fromJSON - Creates a new BaseError instance from a JSON representation.
82
57
 
83
58
  #### Overrides
84
59
 
85
- [CommonError](CommonError.md).[constructor](CommonError.md#constructor)
60
+ [`CommonError`](CommonError.md).[`constructor`](CommonError.md#constructors)
86
61
 
87
62
  #### Defined in
88
63
 
89
- node_modules/.pnpm/@isdk+common-error@0.1.1/node_modules/@isdk/common-error/dist/index.d.ts:132
64
+ node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:132
90
65
 
91
66
  ## Properties
92
67
 
93
68
  ### caller
94
69
 
95
- • **caller**: `string`
70
+ > **caller**: `string`
96
71
 
97
72
  The name of the function that threw the error.
98
73
 
99
74
  #### Inherited from
100
75
 
101
- [CommonError](CommonError.md).[caller](CommonError.md#caller)
76
+ [`CommonError`](CommonError.md).[`caller`](CommonError.md#caller)
102
77
 
103
78
  #### Defined in
104
79
 
105
- node_modules/.pnpm/@isdk+common-error@0.1.1/node_modules/@isdk/common-error/dist/index.d.ts:63
80
+ node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:63
106
81
 
107
- ___
82
+ ***
108
83
 
109
- ### cause
84
+ ### cause?
110
85
 
111
- • `Optional` **cause**: `unknown`
86
+ > `optional` **cause**: `unknown`
112
87
 
113
88
  #### Inherited from
114
89
 
115
- [CommonError](CommonError.md).[cause](CommonError.md#cause)
90
+ [`CommonError`](CommonError.md).[`cause`](CommonError.md#cause)
116
91
 
117
92
  #### Defined in
118
93
 
119
- node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2022.error.d.ts:24
94
+ node\_modules/.pnpm/typescript@5.6.2/node\_modules/typescript/lib/lib.es2022.error.d.ts:24
120
95
 
121
- ___
96
+ ***
122
97
 
123
98
  ### code
124
99
 
125
- • **code**: `ErrorCodeType`
100
+ > **code**: `ErrorCodeType`
101
+
102
+ the error code
126
103
 
127
104
  #### Inherited from
128
105
 
129
- [CommonError](CommonError.md).[code](CommonError.md#code)
106
+ [`CommonError`](CommonError.md).[`code`](CommonError.md#code)
130
107
 
131
108
  #### Defined in
132
109
 
133
- node_modules/.pnpm/@isdk+common-error@0.1.1/node_modules/@isdk/common-error/dist/index.d.ts:64
110
+ node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:64
134
111
 
135
- ___
112
+ ***
136
113
 
137
- ### data
114
+ ### data?
138
115
 
139
- • `Optional` **data**: `any`
116
+ > `optional` **data**: `any`
140
117
 
141
118
  Additional data associated with the error.
142
119
 
143
120
  #### Inherited from
144
121
 
145
- [CommonError](CommonError.md).[data](CommonError.md#data)
122
+ [`CommonError`](CommonError.md).[`data`](CommonError.md#data)
146
123
 
147
124
  #### Defined in
148
125
 
149
- node_modules/.pnpm/@isdk+common-error@0.1.1/node_modules/@isdk/common-error/dist/index.d.ts:65
126
+ node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:65
150
127
 
151
- ___
128
+ ***
152
129
 
153
130
  ### message
154
131
 
155
- • **message**: `string`
132
+ > **message**: `string`
156
133
 
157
134
  #### Inherited from
158
135
 
159
- [CommonError](CommonError.md).[message](CommonError.md#message)
136
+ [`CommonError`](CommonError.md).[`message`](CommonError.md#message)
160
137
 
161
138
  #### Defined in
162
139
 
163
- node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:1077
140
+ node\_modules/.pnpm/typescript@5.6.2/node\_modules/typescript/lib/lib.es5.d.ts:1077
164
141
 
165
- ___
142
+ ***
166
143
 
167
144
  ### name
168
145
 
169
- • **name**: `string`
146
+ > **name**: `string`
170
147
 
171
148
  #### Inherited from
172
149
 
173
- [CommonError](CommonError.md).[name](CommonError.md#name)
150
+ [`CommonError`](CommonError.md).[`name`](CommonError.md#name)
174
151
 
175
152
  #### Defined in
176
153
 
177
- node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:1076
154
+ node\_modules/.pnpm/typescript@5.6.2/node\_modules/typescript/lib/lib.es5.d.ts:1076
178
155
 
179
- ___
156
+ ***
180
157
 
181
- ### stack
158
+ ### stack?
182
159
 
183
- • `Optional` **stack**: `string`
160
+ > `optional` **stack**: `string`
184
161
 
185
162
  #### Inherited from
186
163
 
187
- [CommonError](CommonError.md).[stack](CommonError.md#stack)
164
+ [`CommonError`](CommonError.md).[`stack`](CommonError.md#stack)
188
165
 
189
166
  #### Defined in
190
167
 
191
- node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:1078
168
+ node\_modules/.pnpm/typescript@5.6.2/node\_modules/typescript/lib/lib.es5.d.ts:1078
192
169
 
193
- ___
170
+ ***
194
171
 
195
172
  ### code
196
173
 
197
- ▪ `Static` **code**: [`ErrorCode`](../enums/ErrorCode.md)
174
+ > `static` **code**: [`ErrorCode`](../enumerations/ErrorCode.md)
198
175
 
199
176
  The error code associated with the error.
200
177
 
201
178
  #### Overrides
202
179
 
203
- [CommonError](CommonError.md).[code](CommonError.md#code-1)
180
+ [`CommonError`](CommonError.md).[`code`](CommonError.md#code-1)
204
181
 
205
182
  #### Defined in
206
183
 
207
- node_modules/.pnpm/@isdk+common-error@0.1.1/node_modules/@isdk/common-error/dist/index.d.ts:131
184
+ node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:131
208
185
 
209
- ___
186
+ ***
210
187
 
211
- ### prepareStackTrace
188
+ ### prepareStackTrace()?
212
189
 
213
- ▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
190
+ > `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any`
214
191
 
215
192
  Optional override for formatting stack traces
216
193
 
217
- **`See`**
218
-
219
- https://v8.dev/docs/stack-trace-api#customizing-stack-traces
194
+ #### Parameters
220
195
 
221
- #### Type declaration
196
+ • **err**: `Error`
222
197
 
223
- ▸ (`err`, `stackTraces`): `any`
198
+ • **stackTraces**: `CallSite`[]
224
199
 
225
- ##### Parameters
200
+ #### Returns
226
201
 
227
- | Name | Type |
228
- | :------ | :------ |
229
- | `err` | `Error` |
230
- | `stackTraces` | `CallSite`[] |
202
+ `any`
231
203
 
232
- ##### Returns
204
+ #### See
233
205
 
234
- `any`
206
+ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
235
207
 
236
208
  #### Inherited from
237
209
 
238
- [CommonError](CommonError.md).[prepareStackTrace](CommonError.md#preparestacktrace)
210
+ [`CommonError`](CommonError.md).[`prepareStackTrace`](CommonError.md#preparestacktrace)
239
211
 
240
212
  #### Defined in
241
213
 
242
- node_modules/.pnpm/@types+node@20.14.2/node_modules/@types/node/globals.d.ts:28
214
+ node\_modules/.pnpm/@types+node@22.5.5/node\_modules/@types/node/globals.d.ts:143
243
215
 
244
- ___
216
+ ***
245
217
 
246
218
  ### stackTraceLimit
247
219
 
248
- ▪ `Static` **stackTraceLimit**: `number`
220
+ > `static` **stackTraceLimit**: `number`
249
221
 
250
222
  #### Inherited from
251
223
 
252
- [CommonError](CommonError.md).[stackTraceLimit](CommonError.md#stacktracelimit)
224
+ [`CommonError`](CommonError.md).[`stackTraceLimit`](CommonError.md#stacktracelimit)
253
225
 
254
226
  #### Defined in
255
227
 
256
- node_modules/.pnpm/@types+node@20.14.2/node_modules/@types/node/globals.d.ts:30
228
+ node\_modules/.pnpm/@types+node@22.5.5/node\_modules/@types/node/globals.d.ts:145
257
229
 
258
230
  ## Methods
259
231
 
260
- ### fromJSON
232
+ ### fromJSON()
261
233
 
262
- ▸ **fromJSON**(`json`): [`BaseError`](BaseError.md)
234
+ > **fromJSON**(`json`): [`BaseError`](BaseError.md)
263
235
 
264
236
  Creates a new BaseError instance from a JSON representation.
265
237
 
266
238
  #### Parameters
267
239
 
268
- | Name | Type | Description |
269
- | :------ | :------ | :------ |
270
- | `json` | `any` | A JSON representation of the error. |
240
+ • **json**: `any`
241
+
242
+ A JSON representation of the error.
271
243
 
272
244
  #### Returns
273
245
 
@@ -277,17 +249,17 @@ A new BaseError instance.
277
249
 
278
250
  #### Inherited from
279
251
 
280
- [CommonError](CommonError.md).[fromJSON](CommonError.md#fromjson)
252
+ [`CommonError`](CommonError.md).[`fromJSON`](CommonError.md#fromjson)
281
253
 
282
254
  #### Defined in
283
255
 
284
- node_modules/.pnpm/@isdk+common-error@0.1.1/node_modules/@isdk/common-error/dist/index.d.ts:87
256
+ node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:87
285
257
 
286
- ___
258
+ ***
287
259
 
288
- ### toJSON
260
+ ### toJSON()
289
261
 
290
- ▸ **toJSON**(): `any`
262
+ > **toJSON**(): `any`
291
263
 
292
264
  Returns a JSON representation of the error.
293
265
 
@@ -299,26 +271,25 @@ A JSON representation of the error.
299
271
 
300
272
  #### Inherited from
301
273
 
302
- [CommonError](CommonError.md).[toJSON](CommonError.md#tojson)
274
+ [`CommonError`](CommonError.md).[`toJSON`](CommonError.md#tojson)
303
275
 
304
276
  #### Defined in
305
277
 
306
- node_modules/.pnpm/@isdk+common-error@0.1.1/node_modules/@isdk/common-error/dist/index.d.ts:80
278
+ node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:80
307
279
 
308
- ___
280
+ ***
309
281
 
310
- ### captureStackTrace
282
+ ### captureStackTrace()
311
283
 
312
- ▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
284
+ > `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void`
313
285
 
314
286
  Create .stack property on a target object
315
287
 
316
288
  #### Parameters
317
289
 
318
- | Name | Type |
319
- | :------ | :------ |
320
- | `targetObject` | `object` |
321
- | `constructorOpt?` | `Function` |
290
+ • **targetObject**: `object`
291
+
292
+ • **constructorOpt?**: `Function`
322
293
 
323
294
  #### Returns
324
295
 
@@ -326,34 +297,42 @@ Create .stack property on a target object
326
297
 
327
298
  #### Inherited from
328
299
 
329
- [CommonError](CommonError.md).[captureStackTrace](CommonError.md#capturestacktrace)
300
+ [`CommonError`](CommonError.md).[`captureStackTrace`](CommonError.md#capturestacktrace)
330
301
 
331
302
  #### Defined in
332
303
 
333
- node_modules/.pnpm/@types+node@20.14.2/node_modules/@types/node/globals.d.ts:21
304
+ node\_modules/.pnpm/@types+node@22.5.5/node\_modules/@types/node/globals.d.ts:136
305
+
306
+ ***
334
307
 
335
- ___
308
+ ### createErrorClass()
336
309
 
337
- ### createErrorClass
310
+ > `static` **createErrorClass**(`aType`, `aErrorCode`?, `ParentErrorClass`?): *typeof* [`BaseError`](BaseError.md)
338
311
 
339
- ▸ **createErrorClass**(`aType`, `aErrorCode?`, `ParentErrorClass?`): typeof [`BaseError`](BaseError.md)
312
+ Create an Error Class
340
313
 
341
314
  #### Parameters
342
315
 
343
- | Name | Type |
344
- | :------ | :------ |
345
- | `aType` | `string` |
346
- | `aErrorCode?` | `string` \| `number` \| typeof `AbstractError` |
347
- | `ParentErrorClass?` | typeof [`BaseError`](BaseError.md) |
316
+ • **aType**: `string`
317
+
318
+ the error type(class) name
319
+
320
+ • **aErrorCode?**: `string` \| `number` \| *typeof* `AbstractError`
321
+
322
+ • **ParentErrorClass?**: *typeof* [`BaseError`](BaseError.md)
323
+
324
+ the parent error class. defaults to AbstractError
348
325
 
349
326
  #### Returns
350
327
 
351
- typeof [`BaseError`](BaseError.md)
328
+ *typeof* [`BaseError`](BaseError.md)
329
+
330
+ the new Error Class
352
331
 
353
332
  #### Inherited from
354
333
 
355
- [CommonError](CommonError.md).[createErrorClass](CommonError.md#createerrorclass)
334
+ [`CommonError`](CommonError.md).[`createErrorClass`](CommonError.md#createerrorclass)
356
335
 
357
336
  #### Defined in
358
337
 
359
- node_modules/.pnpm/@isdk+common-error@0.1.1/node_modules/@isdk/common-error/dist/index.d.ts:66
338
+ node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:66