@isdk/ai-tool 0.4.0 → 0.5.1

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 (344) hide show
  1. package/dist/chunk-VIG2GB47.mjs +39 -1
  2. package/dist/chunk-VJ45JQBR.mjs +7829 -0
  3. package/dist/funcs.d.mts +3 -2
  4. package/dist/funcs.d.ts +3 -2
  5. package/dist/funcs.js +5156 -1
  6. package/dist/funcs.mjs +29 -1
  7. package/dist/index-Br-4ZYgE.d.mts +892 -0
  8. package/dist/index-Br-4ZYgE.d.ts +892 -0
  9. package/dist/index.d.mts +204 -237
  10. package/dist/index.d.ts +204 -237
  11. package/dist/index.js +8132 -1
  12. package/dist/index.mjs +476 -1
  13. package/dist/test/util.js +101 -1
  14. package/dist/test/util.mjs +30 -1
  15. package/docs/README.md +1 -1
  16. package/docs/classes/AbortError.md +80 -82
  17. package/docs/classes/AlreadyExistsError.md +80 -82
  18. package/docs/classes/BaseError.md +81 -81
  19. package/docs/classes/BinarySemaphore.md +418 -0
  20. package/docs/classes/CancelableAbility.md +193 -105
  21. package/docs/classes/ClientTools.md +655 -631
  22. package/docs/classes/CommonError.md +85 -85
  23. package/docs/classes/ConfigFile.md +131 -111
  24. package/docs/classes/EnvPromptTemplate.md +1158 -0
  25. package/docs/classes/EventClient.md +766 -736
  26. package/docs/classes/EventEmitter.md +299 -0
  27. package/docs/classes/EventServer.md +783 -757
  28. package/docs/classes/EventToolFunc.md +612 -588
  29. package/docs/classes/FStringPromptTemplate.md +246 -238
  30. package/docs/classes/FewShotPromptTemplate.md +240 -246
  31. package/docs/classes/GolangPromptTemplate.md +246 -238
  32. package/docs/classes/HFEnvironment.md +42 -44
  33. package/docs/classes/HFInterpreter.md +22 -20
  34. package/docs/classes/HFTemplate.md +19 -19
  35. package/docs/classes/HfPromptTemplate.md +246 -238
  36. package/docs/classes/IntSet.md +53 -53
  37. package/docs/classes/LRUCache.md +601 -0
  38. package/docs/classes/NotFoundError.md +80 -82
  39. package/docs/classes/NotImplementationError.md +80 -82
  40. package/docs/classes/PromptExampleSelector.md +39 -39
  41. package/docs/classes/PromptTemplate.md +235 -226
  42. package/docs/classes/ReadableStreamError.md +82 -84
  43. package/docs/classes/ResClientTools.md +662 -630
  44. package/docs/classes/ResServerTools.md +648 -626
  45. package/docs/classes/SSEChannel.md +61 -61
  46. package/docs/classes/Semaphore.md +401 -40
  47. package/docs/classes/ServerTools.md +622 -608
  48. package/docs/classes/SignalGate.md +182 -0
  49. package/docs/classes/TaskAbortController.md +27 -33
  50. package/docs/classes/ToolFunc.md +582 -552
  51. package/docs/classes/YamlTypeBaseObject.md +9 -7
  52. package/docs/enumerations/AsyncFeatureBits.md +6 -10
  53. package/docs/enumerations/AsyncFeatures.md +6 -10
  54. package/docs/enumerations/ErrorCode.md +24 -64
  55. package/docs/enumerations/HashAlgorithm.md +14 -34
  56. package/docs/functions/AIArgProcessor.md +15 -9
  57. package/docs/functions/AIStream.md +9 -7
  58. package/docs/functions/ChoiceArgProcessor.md +15 -9
  59. package/docs/functions/ObjectArgsToArgsInfo.md +29 -0
  60. package/docs/functions/RateLimit.md +13 -9
  61. package/docs/functions/TemplateArgProcessor.md +15 -9
  62. package/docs/functions/assignDirs.md +33 -0
  63. package/docs/functions/backendEventable.md +14 -8
  64. package/docs/functions/beforeShutdown.md +29 -0
  65. package/docs/functions/canonicalize.md +6 -6
  66. package/docs/functions/completeSentences.md +9 -7
  67. package/docs/functions/concatText.md +8 -6
  68. package/docs/functions/countLLMTokens.md +9 -7
  69. package/docs/functions/countRegexMatches.md +9 -7
  70. package/docs/functions/createAbilityInjector.md +66 -34
  71. package/docs/functions/createCallbacksTransformer.md +6 -6
  72. package/docs/functions/createEmptyReadableStream.md +3 -5
  73. package/docs/functions/createEndWithRepetitionDetector.md +9 -7
  74. package/docs/functions/createError.md +12 -8
  75. package/docs/functions/createEventStreamTransformer.md +8 -8
  76. package/docs/functions/createHfValueFunc.md +9 -7
  77. package/docs/functions/createLRUCache.md +9 -7
  78. package/docs/functions/createYamlObjectTag.md +9 -7
  79. package/docs/functions/dateToText.md +9 -7
  80. package/docs/functions/decodeCharset.md +9 -7
  81. package/docs/functions/detectCharset.md +9 -7
  82. package/docs/functions/encodeLLMTokens.md +9 -7
  83. package/docs/functions/ensureQuoted.md +25 -0
  84. package/docs/functions/eventable.md +82 -0
  85. package/docs/functions/expandConfig.md +25 -0
  86. package/docs/functions/expandEnv.md +6 -6
  87. package/docs/functions/expandObjEnv.md +12 -8
  88. package/docs/functions/expandPath.md +25 -0
  89. package/docs/functions/extNameLevel.md +6 -6
  90. package/docs/functions/fileIsExists.md +6 -6
  91. package/docs/functions/filenameReservedRegex.md +3 -5
  92. package/docs/functions/filterValidFnScope.md +6 -6
  93. package/docs/functions/findIndexNonEmptyFrom.md +9 -7
  94. package/docs/functions/findPort.md +9 -7
  95. package/docs/functions/formatISO.md +9 -11
  96. package/docs/functions/formatTextWithSpace.md +13 -9
  97. package/docs/functions/getAllEnumKeys.md +8 -8
  98. package/docs/functions/getConfigFileNames.md +9 -7
  99. package/docs/functions/getConfigs.md +9 -7
  100. package/docs/functions/getEnvVairables.md +21 -0
  101. package/docs/functions/getFileMetaInfo.md +6 -6
  102. package/docs/functions/getHashAlgoBySize.md +6 -6
  103. package/docs/functions/getKeysPath.md +6 -6
  104. package/docs/functions/getLLMTokenizer.md +6 -6
  105. package/docs/functions/getMultiLevelExtname.md +9 -7
  106. package/docs/functions/getPackageDir.md +6 -6
  107. package/docs/functions/getRealFilepath.md +6 -6
  108. package/docs/functions/getResponseErrorReadableStream.md +6 -6
  109. package/docs/functions/getXDGConfigs.md +37 -0
  110. package/docs/functions/hasDirectoryIn.md +9 -7
  111. package/docs/functions/hash.md +25 -0
  112. package/docs/functions/hashFile.md +10 -8
  113. package/docs/functions/hashStream.md +10 -8
  114. package/docs/functions/hfParse.md +6 -6
  115. package/docs/functions/hfTokenize.md +9 -7
  116. package/docs/functions/initShutdown.md +15 -0
  117. package/docs/functions/interpolateEnv.md +13 -9
  118. package/docs/functions/interpolateFString.md +9 -7
  119. package/docs/functions/interpolateGolangTemplate.md +12 -8
  120. package/docs/functions/isLangUsingSpaces.md +6 -6
  121. package/docs/functions/isListItemString.md +6 -6
  122. package/docs/functions/isModelNameMatched.md +9 -7
  123. package/docs/functions/isPunctuationChar.md +6 -6
  124. package/docs/functions/isQuoted.md +21 -0
  125. package/docs/functions/isRegExp.md +6 -6
  126. package/docs/functions/isSameString.md +36 -0
  127. package/docs/functions/isSectionString.md +9 -7
  128. package/docs/functions/isSentenceEnding.md +6 -6
  129. package/docs/functions/isSepLineString.md +6 -6
  130. package/docs/functions/isStrWrapped.md +25 -0
  131. package/docs/functions/isSubdirectory.md +9 -7
  132. package/docs/functions/isTitleString.md +9 -7
  133. package/docs/functions/isValidFilename.md +6 -6
  134. package/docs/functions/isValidFilepath.md +6 -6
  135. package/docs/functions/isWebStream.md +6 -6
  136. package/docs/functions/jsonFilterToWhere.md +9 -7
  137. package/docs/functions/jsonToMarkdownStr.md +18 -10
  138. package/docs/functions/loadAIConfig.md +21 -0
  139. package/docs/functions/loadConfig.md +25 -0
  140. package/docs/functions/loadConfigFile.md +25 -0
  141. package/docs/functions/loadFileFromPaths.md +24 -14
  142. package/docs/functions/loadTextFromPaths.md +18 -10
  143. package/docs/functions/lrucache.md +17 -11
  144. package/docs/functions/makeToolFuncCancelable.md +14 -8
  145. package/docs/functions/matchUrlProtocol.md +6 -6
  146. package/docs/functions/memoize.md +9 -7
  147. package/docs/functions/messagesToText.md +6 -6
  148. package/docs/functions/paramsSizeToScaleStr.md +9 -7
  149. package/docs/functions/parseCommand.md +13 -9
  150. package/docs/functions/parseDateFormat.md +15 -13
  151. package/docs/functions/parseFString.md +6 -6
  152. package/docs/functions/parseISO.md +9 -11
  153. package/docs/functions/parseJsJson.md +9 -7
  154. package/docs/functions/parseJsJsonSimpleSync.md +9 -7
  155. package/docs/functions/parseObjectArgInfo.md +15 -9
  156. package/docs/functions/parseObjectArgumentInfos.md +12 -8
  157. package/docs/functions/parseObjectArguments.md +12 -8
  158. package/docs/functions/parseObjectArgumentsAsArgInfos.md +12 -8
  159. package/docs/functions/parseYaml.md +11 -7
  160. package/docs/functions/quoteStr.md +6 -6
  161. package/docs/functions/reControlCharsRegex.md +3 -5
  162. package/docs/functions/readFilenamesRecursiveSync.md +16 -10
  163. package/docs/functions/readTextFileChunks.md +9 -7
  164. package/docs/functions/readTextFileChunksEx.md +9 -7
  165. package/docs/functions/readableFromAsyncIterable.md +6 -6
  166. package/docs/functions/registerCoreTools.md +3 -5
  167. package/docs/functions/registerYamlTag.md +6 -6
  168. package/docs/functions/removeMarkdownBold.md +9 -7
  169. package/docs/functions/removeMarkdownBoldAndItalic.md +9 -7
  170. package/docs/functions/removeMarkdownItalic.md +9 -7
  171. package/docs/functions/replaceWithPlaceholder.md +11 -9
  172. package/docs/functions/restoreFromPlacehoders.md +12 -8
  173. package/docs/functions/sanitizeFilename.md +9 -7
  174. package/docs/functions/sanitizeFilepath.md +9 -7
  175. package/docs/functions/saveConfigFile.md +12 -8
  176. package/docs/functions/scaleStrToParamsSize.md +6 -6
  177. package/docs/functions/shutdown.md +33 -0
  178. package/docs/functions/simplifyObjectArguments.md +6 -6
  179. package/docs/functions/sortedValues.md +6 -6
  180. package/docs/functions/splitChunks.md +9 -7
  181. package/docs/functions/splitParagraph.md +9 -7
  182. package/docs/functions/splitSentence.md +9 -7
  183. package/docs/functions/stringifyYaml.md +11 -7
  184. package/docs/functions/stripConsoleColor.md +6 -6
  185. package/docs/functions/textToDate.md +9 -7
  186. package/docs/functions/throwError.md +12 -8
  187. package/docs/functions/toDate.md +9 -11
  188. package/docs/functions/toDateTime.md +6 -6
  189. package/docs/functions/toRegExp.md +6 -6
  190. package/docs/functions/trimStartOfStreamHelper.md +6 -6
  191. package/docs/functions/truncTo.md +12 -8
  192. package/docs/functions/truncateByToken.md +9 -7
  193. package/docs/functions/truncateToTokenLimit.md +9 -7
  194. package/docs/functions/truncateToTokenLimitEx.md +9 -7
  195. package/docs/functions/uuid.md +9 -7
  196. package/docs/functions/uuidParse.md +6 -6
  197. package/docs/functions/uuidStringify.md +10 -8
  198. package/docs/functions/uuidValidate.md +6 -6
  199. package/docs/functions/uuidVersion.md +6 -6
  200. package/docs/functions/uuidv1.md +28 -20
  201. package/docs/functions/uuidv4.md +28 -20
  202. package/docs/functions/uuidv5.md +34 -22
  203. package/docs/functions/wait.md +6 -6
  204. package/docs/functions/wrapEventEmitter.md +27 -0
  205. package/docs/functions/xxhash.md +12 -8
  206. package/docs/functions/xxhash32.md +9 -7
  207. package/docs/functions/xxhash64.md +9 -7
  208. package/docs/functions/xxhashAsStr.md +12 -8
  209. package/docs/globals.md +45 -1
  210. package/docs/interfaces/AIChatAssistantMessageParam.md +42 -30
  211. package/docs/interfaces/AIChatContentPartImage.md +6 -8
  212. package/docs/interfaces/AIChatContentPartText.md +5 -7
  213. package/docs/interfaces/AIChatMessageParamBase.md +23 -13
  214. package/docs/interfaces/AIChatMessageToolCall.md +7 -11
  215. package/docs/interfaces/AIChatSystemMessageParam.md +40 -22
  216. package/docs/interfaces/AIChatToolChoiceFuncObject.md +37 -0
  217. package/docs/interfaces/AIChatToolChoiceObject.md +25 -0
  218. package/docs/interfaces/AIChatToolFunc.md +41 -0
  219. package/docs/interfaces/AIChatToolFuncParam.md +37 -0
  220. package/docs/interfaces/AIChatToolMessageParam.md +40 -24
  221. package/docs/interfaces/AIChatToolParam.md +25 -0
  222. package/docs/interfaces/AIChatToolTypeObject.md +17 -0
  223. package/docs/interfaces/AIChatUserMessageParam.md +44 -34
  224. package/docs/interfaces/AIChoiceConfig.md +10 -22
  225. package/docs/interfaces/AIResult.md +13 -21
  226. package/docs/interfaces/AIStreamParser.md +11 -7
  227. package/docs/interfaces/AIStreamParserOptions.md +5 -5
  228. package/docs/interfaces/BaseFunc.md +30 -40
  229. package/docs/interfaces/BaseFuncItem.md +18 -28
  230. package/docs/interfaces/BinarySemaphoreAcquireOptions.md +25 -0
  231. package/docs/interfaces/BinarySemaphoreOptions.md +57 -0
  232. package/docs/interfaces/BinarySemaphoreReleaseOptions.md +25 -0
  233. package/docs/interfaces/BinarySemaphoreReleaserFunc.md +37 -0
  234. package/docs/interfaces/CancelableAbilityOptions.md +27 -29
  235. package/docs/interfaces/ClientFuncItem.md +31 -47
  236. package/docs/interfaces/DotenvExpandOptions.md +8 -12
  237. package/docs/interfaces/DotenvExpandOutput.md +5 -7
  238. package/docs/interfaces/DotenvParseInput.md +4 -2
  239. package/docs/interfaces/DotenvParseOutput.md +4 -2
  240. package/docs/interfaces/DotenvPopulateInput.md +4 -2
  241. package/docs/interfaces/EventClientFuncParams.md +11 -15
  242. package/docs/interfaces/EventServerFuncParams.md +14 -18
  243. package/docs/interfaces/FewShotPromptTemplateOptions.md +29 -45
  244. package/docs/interfaces/FuncItem.md +26 -38
  245. package/docs/interfaces/FuncParam.md +11 -21
  246. package/docs/interfaces/FuncParams.md +4 -2
  247. package/docs/interfaces/Funcs.md +4 -2
  248. package/docs/interfaces/HashAlgoParams.md +6 -10
  249. package/docs/interfaces/IFileMetaInfo.md +10 -22
  250. package/docs/interfaces/IReadTextFileChunksOptions.md +29 -43
  251. package/docs/interfaces/ITruncateToTokenLimitOptions.md +19 -31
  252. package/docs/interfaces/JsonFilter.md +4 -2
  253. package/docs/interfaces/ParseObjectArgumentOptions.md +13 -31
  254. package/docs/interfaces/PromptExampleSelectorOptions.md +8 -10
  255. package/docs/interfaces/PromptTemplateOptions.md +10 -20
  256. package/docs/interfaces/RemoteFuncItem.md +28 -44
  257. package/docs/interfaces/ReplacePlacehoderOptions.md +7 -13
  258. package/docs/interfaces/ResClientFuncParams.md +10 -8
  259. package/docs/interfaces/ResServerFuncParams.md +15 -19
  260. package/docs/interfaces/SanitizeFilenameOptions.md +5 -7
  261. package/docs/interfaces/SectionStringOptions.md +5 -7
  262. package/docs/interfaces/SemaphoreOptions.md +89 -0
  263. package/docs/interfaces/SemaphoreTaskItem.md +73 -0
  264. package/docs/interfaces/ServerFuncItem.md +32 -50
  265. package/docs/interfaces/ServerFuncParams.md +6 -8
  266. package/docs/interfaces/SplitSentenceOptions.md +7 -13
  267. package/docs/interfaces/StreamCallbacksAndOptions.md +26 -22
  268. package/docs/interfaces/TaskAbortControllers.md +4 -2
  269. package/docs/interfaces/TaskPromise.md +24 -24
  270. package/docs/interfaces/ToolFuncPackage.md +11 -13
  271. package/docs/namespaces/EventStates/README.md +14 -0
  272. package/docs/namespaces/EventStates/variables/ABORT.md +11 -0
  273. package/docs/namespaces/EventStates/variables/CONTINUE.md +11 -0
  274. package/docs/namespaces/EventStates/variables/DONE.md +11 -0
  275. package/docs/namespaces/EventStates/variables/STOPPED.md +11 -0
  276. package/docs/namespaces/uuidv5/README.md +12 -0
  277. package/docs/namespaces/uuidv5/variables/DNS.md +11 -0
  278. package/docs/namespaces/uuidv5/variables/URL.md +11 -0
  279. package/docs/type-aliases/AIChatContentPart.md +2 -4
  280. package/docs/type-aliases/AIChatMessageParam.md +3 -5
  281. package/docs/type-aliases/AIChatRole.md +2 -4
  282. package/docs/type-aliases/AIChatToolChoiceParam.md +11 -0
  283. package/docs/type-aliases/AIMessageType.md +2 -4
  284. package/docs/type-aliases/AIModelNameRule.md +2 -4
  285. package/docs/type-aliases/AIModelNameRuleFn.md +6 -6
  286. package/docs/type-aliases/AIModelNameRules.md +2 -4
  287. package/docs/type-aliases/AITextGenerationFinishReason.md +2 -4
  288. package/docs/type-aliases/ActionName.md +2 -4
  289. package/docs/type-aliases/AsyncTaskId.md +2 -4
  290. package/docs/type-aliases/BeforeShutdownListener.md +23 -0
  291. package/docs/type-aliases/EventErrorListenerFn.md +15 -9
  292. package/docs/type-aliases/EventListenerFn.md +12 -8
  293. package/docs/type-aliases/FStringPromptTemplateNode.md +4 -6
  294. package/docs/type-aliases/FuncParamType.md +2 -4
  295. package/docs/type-aliases/PromptExamples.md +3 -5
  296. package/docs/type-aliases/PromptTemplateType.md +2 -4
  297. package/docs/type-aliases/PromptType.md +2 -4
  298. package/docs/type-aliases/SemaphoreIsReadyFuncType.md +15 -0
  299. package/docs/type-aliases/TFunc.md +9 -7
  300. package/docs/variables/AIChatRoles.md +3 -5
  301. package/docs/variables/AIMessageTypes.md +3 -5
  302. package/docs/variables/AITextGenerationFinishReasons.md +3 -5
  303. package/docs/variables/AbortErrorCode.md +2 -4
  304. package/docs/variables/ActionNames.md +3 -5
  305. package/docs/variables/AlreadyExistsErrorCode.md +2 -4
  306. package/docs/variables/ClientToolFuncSchema.md +40 -26
  307. package/docs/variables/DEFAULT_CONFIG_NAME.md +11 -0
  308. package/docs/variables/DefaultAsyncSemaphoreCapacity.md +2 -4
  309. package/docs/variables/EventBusName.md +2 -4
  310. package/docs/variables/EventName.md +2 -4
  311. package/docs/variables/FilenameReservedRegex.md +3 -5
  312. package/docs/variables/HFBuiltins.md +42 -12
  313. package/docs/variables/InternalErrorCode.md +2 -4
  314. package/docs/variables/LLM_TOKENIZER_NAMES.md +5 -7
  315. package/docs/variables/LLM_TOKENIZER_NAMES_MAP.md +2 -4
  316. package/docs/variables/NotFoundErrorCode.md +2 -4
  317. package/docs/variables/NotImplementedErrorCode.md +2 -4
  318. package/docs/variables/PASSING_SCORE.md +2 -4
  319. package/docs/variables/PromptTemplateTypes.md +3 -5
  320. package/docs/variables/PromptTypes.md +4 -6
  321. package/docs/variables/RStreamErrCode.md +2 -4
  322. package/docs/variables/RemoteToolFuncSchema.md +40 -26
  323. package/docs/variables/ResponseRStreamErrCode.md +2 -4
  324. package/docs/variables/SHUTDOWN_SIGNALS.md +17 -0
  325. package/docs/variables/SSEChannelAlreadyClosedErrCode.md +2 -4
  326. package/docs/variables/SecondaryCache.md +11 -0
  327. package/docs/variables/ServerToolFuncSchema.md +40 -26
  328. package/docs/variables/ToolAsyncCancelableBit.md +2 -4
  329. package/docs/variables/ToolAsyncMultiTaskBit.md +2 -4
  330. package/docs/variables/ToolAsyncPriorityBit.md +2 -4
  331. package/docs/variables/ToolFuncSchema.md +33 -25
  332. package/docs/variables/WindowsReservedNameRegex.md +3 -5
  333. package/docs/variables/base32768.md +2 -4
  334. package/docs/variables/defaultTemplateFormat.md +2 -4
  335. package/docs/variables/event.md +2 -4
  336. package/docs/variables/eventClient.md +2 -4
  337. package/docs/variables/eventServer.md +2 -4
  338. package/docs/variables/lrucache.md +2 -4
  339. package/docs/variables/mimeType.md +2 -4
  340. package/docs/variables/uuidNIL.md +3 -5
  341. package/package.json +31 -31
  342. package/dist/chunk-SIP3XWIH.mjs +0 -1
  343. package/dist/index-BC3GQn6-.d.mts +0 -488
  344. package/dist/index-BC3GQn6-.d.ts +0 -488
package/docs/classes/AbortError.md CHANGED
@@ -1,4 +1,4 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
1
+ [**@isdk/ai-tool**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -6,6 +6,8 @@
6
6
 
7
7
  # Class: AbortError
8
8
 
9
+ Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:142
10
+
9
11
  BaseError class that extends the Error class.
10
12
 
11
13
  ## Example
@@ -45,11 +47,17 @@ fromJSON - Creates a new BaseError instance from a JSON representation.
45
47
 
46
48
  > **new AbortError**(`what`?, `name`?): [`AbortError`](AbortError.md)
47
49
 
50
+ Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:144
51
+
48
52
  #### Parameters
49
53
 
50
- • **what?**: `string`
54
+ ##### what?
55
+
56
+ `string`
51
57
 
52
- • **name?**: `string` \| `Record`\<`string`, `any`\>
58
+ ##### name?
59
+
60
+ `string` | `Record`\<`string`, `any`\>
53
61
 
54
62
  #### Returns
55
63
 
@@ -59,85 +67,71 @@ fromJSON - Creates a new BaseError instance from a JSON representation.
59
67
 
60
68
  [`CommonError`](CommonError.md).[`constructor`](CommonError.md#constructors)
61
69
 
62
- #### Defined in
63
-
64
- node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:144
65
-
66
70
  ## Properties
67
71
 
68
72
  ### caller
69
73
 
70
74
  > **caller**: `string`
71
75
 
76
+ Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:63
77
+
72
78
  The name of the function that threw the error.
73
79
 
74
80
  #### Inherited from
75
81
 
76
82
  [`CommonError`](CommonError.md).[`caller`](CommonError.md#caller)
77
83
 
78
- #### Defined in
79
-
80
- node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:63
81
-
82
84
  ***
83
85
 
84
86
  ### cause?
85
87
 
86
88
  > `optional` **cause**: `unknown`
87
89
 
90
+ Defined in: node\_modules/.pnpm/typescript@5.7.2/node\_modules/typescript/lib/lib.es2022.error.d.ts:26
91
+
88
92
  #### Inherited from
89
93
 
90
94
  [`CommonError`](CommonError.md).[`cause`](CommonError.md#cause)
91
95
 
92
- #### Defined in
93
-
94
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:24
95
-
96
96
  ***
97
97
 
98
98
  ### code
99
99
 
100
100
  > **code**: `ErrorCodeType`
101
101
 
102
+ Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:64
103
+
102
104
  the error code
103
105
 
104
106
  #### Inherited from
105
107
 
106
108
  [`CommonError`](CommonError.md).[`code`](CommonError.md#code)
107
109
 
108
- #### Defined in
109
-
110
- node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:64
111
-
112
110
  ***
113
111
 
114
112
  ### data?
115
113
 
116
114
  > `optional` **data**: `any`
117
115
 
116
+ Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:65
117
+
118
118
  Additional data associated with the error.
119
119
 
120
120
  #### Inherited from
121
121
 
122
122
  [`CommonError`](CommonError.md).[`data`](CommonError.md#data)
123
123
 
124
- #### Defined in
125
-
126
- node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:65
127
-
128
124
  ***
129
125
 
130
126
  ### message
131
127
 
132
128
  > **message**: `string`
133
129
 
134
- #### Inherited from
135
-
136
- [`CommonError`](CommonError.md).[`message`](CommonError.md#message)
130
+ Defined in: node\_modules/.pnpm/typescript@5.7.2/node\_modules/typescript/lib/lib.es5.d.ts:1077
137
131
 
138
- #### Defined in
132
+ #### Inherited from
139
133
 
140
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1077
134
+ [`CommonError`](CommonError.md).[`message`](CommonError.md#message-1)
141
135
 
142
136
  ***
143
137
 
@@ -145,13 +139,11 @@ node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1
145
139
 
146
140
  > **name**: `string`
147
141
 
148
- #### Inherited from
149
-
150
- [`CommonError`](CommonError.md).[`name`](CommonError.md#name)
142
+ Defined in: node\_modules/.pnpm/typescript@5.7.2/node\_modules/typescript/lib/lib.es5.d.ts:1076
151
143
 
152
- #### Defined in
144
+ #### Inherited from
153
145
 
154
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1076
146
+ [`CommonError`](CommonError.md).[`name`](CommonError.md#name-1)
155
147
 
156
148
  ***
157
149
 
@@ -159,43 +151,45 @@ node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1
159
151
 
160
152
  > `optional` **stack**: `string`
161
153
 
154
+ Defined in: node\_modules/.pnpm/typescript@5.7.2/node\_modules/typescript/lib/lib.es5.d.ts:1078
155
+
162
156
  #### Inherited from
163
157
 
164
158
  [`CommonError`](CommonError.md).[`stack`](CommonError.md#stack)
165
159
 
166
- #### Defined in
167
-
168
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1078
169
-
170
160
  ***
171
161
 
172
162
  ### code
173
163
 
174
164
  > `static` **code**: [`ErrorCode`](../enumerations/ErrorCode.md)
175
165
 
166
+ Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:143
167
+
176
168
  The error code associated with the error.
177
169
 
178
170
  #### Overrides
179
171
 
180
172
  [`CommonError`](CommonError.md).[`code`](CommonError.md#code-1)
181
173
 
182
- #### Defined in
183
-
184
- node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:143
185
-
186
174
  ***
187
175
 
188
176
  ### prepareStackTrace()?
189
177
 
190
178
  > `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any`
191
179
 
180
+ Defined in: node\_modules/.pnpm/@types+node@22.10.5/node\_modules/@types/node/globals.d.ts:143
181
+
192
182
  Optional override for formatting stack traces
193
183
 
194
184
  #### Parameters
195
185
 
196
- • **err**: `Error`
186
+ ##### err
187
+
188
+ `Error`
189
+
190
+ ##### stackTraces
197
191
 
198
- • **stackTraces**: `CallSite`[]
192
+ `CallSite`[]
199
193
 
200
194
  #### Returns
201
195
 
@@ -209,35 +203,33 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
209
203
 
210
204
  [`CommonError`](CommonError.md).[`prepareStackTrace`](CommonError.md#preparestacktrace)
211
205
 
212
- #### Defined in
213
-
214
- node\_modules/.pnpm/@types+node@22.7.6/node\_modules/@types/node/globals.d.ts:143
215
-
216
206
  ***
217
207
 
218
208
  ### stackTraceLimit
219
209
 
220
210
  > `static` **stackTraceLimit**: `number`
221
211
 
212
+ Defined in: node\_modules/.pnpm/@types+node@22.10.5/node\_modules/@types/node/globals.d.ts:145
213
+
222
214
  #### Inherited from
223
215
 
224
216
  [`CommonError`](CommonError.md).[`stackTraceLimit`](CommonError.md#stacktracelimit)
225
217
 
226
- #### Defined in
227
-
228
- node\_modules/.pnpm/@types+node@22.7.6/node\_modules/@types/node/globals.d.ts:145
229
-
230
218
  ## Methods
231
219
 
232
220
  ### fromJSON()
233
221
 
234
222
  > **fromJSON**(`json`): [`BaseError`](BaseError.md)
235
223
 
224
+ Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:93
225
+
236
226
  Creates a new BaseError instance from a JSON representation.
237
227
 
238
228
  #### Parameters
239
229
 
240
- • **json**: `any`
230
+ ##### json
231
+
232
+ `any`
241
233
 
242
234
  A JSON representation of the error.
243
235
 
@@ -251,16 +243,14 @@ A new BaseError instance.
251
243
 
252
244
  [`CommonError`](CommonError.md).[`fromJSON`](CommonError.md#fromjson)
253
245
 
254
- #### Defined in
255
-
256
- node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:93
257
-
258
246
  ***
259
247
 
260
248
  ### toJSON()
261
249
 
262
250
  > **toJSON**(): `any`
263
251
 
252
+ Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:86
253
+
264
254
  Returns a JSON representation of the error.
265
255
 
266
256
  #### Returns
@@ -273,23 +263,25 @@ A JSON representation of the error.
273
263
 
274
264
  [`CommonError`](CommonError.md).[`toJSON`](CommonError.md#tojson)
275
265
 
276
- #### Defined in
277
-
278
- node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:86
279
-
280
266
  ***
281
267
 
282
268
  ### captureStackTrace()
283
269
 
284
270
  > `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void`
285
271
 
272
+ Defined in: node\_modules/.pnpm/@types+node@22.10.5/node\_modules/@types/node/globals.d.ts:136
273
+
286
274
  Create .stack property on a target object
287
275
 
288
276
  #### Parameters
289
277
 
290
- • **targetObject**: `object`
278
+ ##### targetObject
279
+
280
+ `object`
291
281
 
292
- • **constructorOpt?**: `Function`
282
+ ##### constructorOpt?
283
+
284
+ `Function`
293
285
 
294
286
  #### Returns
295
287
 
@@ -299,27 +291,33 @@ Create .stack property on a target object
299
291
 
300
292
  [`CommonError`](CommonError.md).[`captureStackTrace`](CommonError.md#capturestacktrace)
301
293
 
302
- #### Defined in
303
-
304
- node\_modules/.pnpm/@types+node@22.7.6/node\_modules/@types/node/globals.d.ts:136
305
-
306
294
  ***
307
295
 
308
296
  ### create()
309
297
 
310
298
  > `static` **create**(`__namedParameters`): [`CommonError`](CommonError.md)
311
299
 
300
+ Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:96
301
+
312
302
  #### Parameters
313
303
 
314
- • **\_\_namedParameters**
304
+ ##### \_\_namedParameters
305
+
306
+ ###### code?
307
+
308
+ `string` \| `number`
315
309
 
316
- • **\_\_namedParameters.code?**: `string` \| `number`
310
+ ###### data?
317
311
 
318
- • **\_\_namedParameters.data?**: `any`
312
+ `any`
313
+
314
+ ###### error
319
315
 
320
- • **\_\_namedParameters.error**: `string`
316
+ `string`
321
317
 
322
- • **\_\_namedParameters.name?**: `string`
318
+ ###### name?
319
+
320
+ `string`
323
321
 
324
322
  #### Returns
325
323
 
@@ -329,27 +327,31 @@ node\_modules/.pnpm/@types+node@22.7.6/node\_modules/@types/node/globals.d.ts:13
329
327
 
330
328
  [`CommonError`](CommonError.md).[`create`](CommonError.md#create)
331
329
 
332
- #### Defined in
333
-
334
- node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:96
335
-
336
330
  ***
337
331
 
338
332
  ### createErrorClass()
339
333
 
340
334
  > `static` **createErrorClass**(`aType`, `aErrorCode`?, `ParentErrorClass`?): *typeof* [`BaseError`](BaseError.md)
341
335
 
336
+ Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:66
337
+
342
338
  Create an Error Class
343
339
 
344
340
  #### Parameters
345
341
 
346
- • **aType**: `string`
342
+ ##### aType
343
+
344
+ `string`
347
345
 
348
346
  the error type(class) name
349
347
 
350
- • **aErrorCode?**: `string` \| `number` \| *typeof* `AbstractError`
348
+ ##### aErrorCode?
349
+
350
+ `string` | `number` | *typeof* `AbstractError`
351
351
 
352
- • **ParentErrorClass?**: *typeof* [`BaseError`](BaseError.md)
352
+ ##### ParentErrorClass?
353
+
354
+ *typeof* [`BaseError`](BaseError.md)
353
355
 
354
356
  the parent error class. defaults to AbstractError
355
357
 
@@ -362,7 +364,3 @@ the new Error Class
362
364
  #### Inherited from
363
365
 
364
366
  [`CommonError`](CommonError.md).[`createErrorClass`](CommonError.md#createerrorclass)
365
-
366
- #### Defined in
367
-
368
- node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:66