@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/CancelableAbility.md CHANGED
@@ -1,51 +1,20 @@
1
- [@isdk/ai-tool](../README.md) / [Exports](../modules.md) / CancelableAbility
1
+ [**@isdk/ai-tool**](../README.md) • **Docs**
2
2
 
3
- # Class: CancelableAbility
4
-
5
- ## Indexable
6
-
7
- ▪ [name: `string`]: `any`
8
-
9
- ## Table of contents
10
-
11
- ### Constructors
12
-
13
- - [constructor](CancelableAbility.md#constructor)
14
-
15
- ### Properties
3
+ ***
16
4
 
17
- - [\_\_task\_aborter](CancelableAbility.md#__task_aborter)
18
- - [\_\_task\_semaphore](CancelableAbility.md#__task_semaphore)
19
- - [\_asyncFeatures](CancelableAbility.md#_asyncfeatures)
20
- - [\_maxTaskConcurrency](CancelableAbility.md#_maxtaskconcurrency)
21
- - [cleanMultiTaskAborter](CancelableAbility.md#cleanmultitaskaborter)
22
- - [generateAsyncTaskId](CancelableAbility.md#generateasynctaskid)
5
+ [@isdk/ai-tool](../globals.md) / CancelableAbility
23
6
 
24
- ### Accessors
25
-
26
- - [maxTaskConcurrency](CancelableAbility.md#maxtaskconcurrency)
27
- - [semaphore](CancelableAbility.md#semaphore)
7
+ # Class: CancelableAbility
28
8
 
29
- ### Methods
9
+ ## Indexable
30
10
 
31
- - [$cleanMultiTaskAborter](CancelableAbility.md#$cleanmultitaskaborter)
32
- - [$generateAsyncTaskId](CancelableAbility.md#$generateasynctaskid)
33
- - [\_cleanMultiTaskAborter](CancelableAbility.md#_cleanmultitaskaborter)
34
- - [\_generateAsyncTaskId](CancelableAbility.md#_generateasynctaskid)
35
- - [abort](CancelableAbility.md#abort)
36
- - [cleanTaskAborter](CancelableAbility.md#cleantaskaborter)
37
- - [createAborter](CancelableAbility.md#createaborter)
38
- - [createTaskPromise](CancelableAbility.md#createtaskpromise)
39
- - [getRunningTask](CancelableAbility.md#getrunningtask)
40
- - [getRunningTaskCount](CancelableAbility.md#getrunningtaskcount)
41
- - [isAborted](CancelableAbility.md#isaborted)
42
- - [runAsyncCancelableTask](CancelableAbility.md#runasynccancelabletask)
11
+ \[`name`: `string`\]: `any`
43
12
 
44
13
  ## Constructors
45
14
 
46
- ### constructor
15
+ ### new CancelableAbility()
47
16
 
48
- • **new CancelableAbility**(): [`CancelableAbility`](CancelableAbility.md)
17
+ > **new CancelableAbility**(): [`CancelableAbility`](CancelableAbility.md)
49
18
 
50
19
  #### Returns
51
20
 
@@ -55,97 +24,87 @@
55
24
 
56
25
  ### \_\_task\_aborter
57
26
 
58
- • **\_\_task\_aborter**: `undefined` \| [`TaskAbortController`](TaskAbortController.md) \| [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md)
27
+ > **\_\_task\_aborter**: `undefined` \| [`TaskAbortController`](TaskAbortController.md) \| [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md)
59
28
 
60
29
  #### Defined in
61
30
 
62
- [packages/ai-tool/src/utils/cancelable-ability.ts:65](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/cancelable-ability.ts#L65)
31
+ [packages/ai-tool/src/utils/cancelable-ability.ts:65](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/cancelable-ability.ts#L65)
63
32
 
64
- ___
33
+ ***
65
34
 
66
35
  ### \_\_task\_semaphore
67
36
 
68
- • **\_\_task\_semaphore**: `undefined` \| [`Semaphore`](Semaphore.md)
37
+ > **\_\_task\_semaphore**: `undefined` \| [`Semaphore`](Semaphore.md)
69
38
 
70
39
  #### Defined in
71
40
 
72
- [packages/ai-tool/src/utils/cancelable-ability.ts:66](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/cancelable-ability.ts#L66)
41
+ [packages/ai-tool/src/utils/cancelable-ability.ts:66](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/cancelable-ability.ts#L66)
73
42
 
74
- ___
43
+ ***
75
44
 
76
- ### \_asyncFeatures
45
+ ### \_asyncFeatures?
77
46
 
78
- • `Optional` **\_asyncFeatures**: `number`
47
+ > `optional` **\_asyncFeatures**: `number`
79
48
 
80
49
  #### Defined in
81
50
 
82
- [packages/ai-tool/src/utils/cancelable-ability.ts:55](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/cancelable-ability.ts#L55)
51
+ [packages/ai-tool/src/utils/cancelable-ability.ts:55](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/cancelable-ability.ts#L55)
83
52
 
84
- ___
53
+ ***
85
54
 
86
55
  ### \_maxTaskConcurrency
87
56
 
88
- • **\_maxTaskConcurrency**: `undefined` \| `number`
57
+ > **\_maxTaskConcurrency**: `undefined` \| `number`
89
58
 
90
59
  #### Defined in
91
60
 
92
- [packages/ai-tool/src/utils/cancelable-ability.ts:56](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/cancelable-ability.ts#L56)
93
-
94
- ___
61
+ [packages/ai-tool/src/utils/cancelable-ability.ts:56](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/cancelable-ability.ts#L56)
95
62
 
96
- ### cleanMultiTaskAborter
63
+ ***
97
64
 
98
- • **cleanMultiTaskAborter**: (`id`: [`AsyncTaskId`](../modules.md#asynctaskid), `aborters`: [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md)) => `void`
65
+ ### cleanMultiTaskAborter()
99
66
 
100
- #### Type declaration
67
+ > **cleanMultiTaskAborter**: (`id`, `aborters`) => `void`
101
68
 
102
- ▸ (`id`, `aborters`): `void`
69
+ #### Parameters
103
70
 
104
- ##### Parameters
71
+ • **id**: [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
105
72
 
106
- | Name | Type |
107
- | :------ | :------ |
108
- | `id` | [`AsyncTaskId`](../modules.md#asynctaskid) |
109
- | `aborters` | [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md) |
73
+ • **aborters**: [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md)
110
74
 
111
- ##### Returns
75
+ #### Returns
112
76
 
113
77
  `void`
114
78
 
115
79
  #### Defined in
116
80
 
117
- [packages/ai-tool/src/utils/cancelable-ability.ts:63](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/cancelable-ability.ts#L63)
81
+ [packages/ai-tool/src/utils/cancelable-ability.ts:63](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/cancelable-ability.ts#L63)
118
82
 
119
- ___
83
+ ***
120
84
 
121
- ### generateAsyncTaskId
85
+ ### generateAsyncTaskId()
122
86
 
123
- • **generateAsyncTaskId**: (`taskId?`: [`AsyncTaskId`](../modules.md#asynctaskid), `aborters?`: [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md)) => [`AsyncTaskId`](../modules.md#asynctaskid)
87
+ > **generateAsyncTaskId**: (`taskId`?, `aborters`?) => [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
124
88
 
125
- #### Type declaration
126
-
127
- ▸ (`taskId?`, `aborters?`): [`AsyncTaskId`](../modules.md#asynctaskid)
89
+ #### Parameters
128
90
 
129
- ##### Parameters
91
+ • **taskId?**: [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
130
92
 
131
- | Name | Type |
132
- | :------ | :------ |
133
- | `taskId?` | [`AsyncTaskId`](../modules.md#asynctaskid) |
134
- | `aborters?` | [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md) |
93
+ • **aborters?**: [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md)
135
94
 
136
- ##### Returns
95
+ #### Returns
137
96
 
138
- [`AsyncTaskId`](../modules.md#asynctaskid)
97
+ [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
139
98
 
140
99
  #### Defined in
141
100
 
142
- [packages/ai-tool/src/utils/cancelable-ability.ts:62](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/cancelable-ability.ts#L62)
101
+ [packages/ai-tool/src/utils/cancelable-ability.ts:62](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/cancelable-ability.ts#L62)
143
102
 
144
103
  ## Accessors
145
104
 
146
105
  ### maxTaskConcurrency
147
106
 
148
- • `get` **maxTaskConcurrency**(): `undefined` \| `number`
107
+ > `get` **maxTaskConcurrency**(): `undefined` \| `number`
149
108
 
150
109
  #### Returns
151
110
 
@@ -153,13 +112,13 @@ ___
153
112
 
154
113
  #### Defined in
155
114
 
156
- [packages/ai-tool/src/utils/cancelable-ability.ts:68](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/cancelable-ability.ts#L68)
115
+ [packages/ai-tool/src/utils/cancelable-ability.ts:68](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/cancelable-ability.ts#L68)
157
116
 
158
- ___
117
+ ***
159
118
 
160
119
  ### semaphore
161
120
 
162
- • `get` **semaphore**(): `undefined` \| [`Semaphore`](Semaphore.md)
121
+ > `get` **semaphore**(): `undefined` \| [`Semaphore`](Semaphore.md)
163
122
 
164
123
  #### Returns
165
124
 
@@ -167,20 +126,19 @@ ___
167
126
 
168
127
  #### Defined in
169
128
 
170
- [packages/ai-tool/src/utils/cancelable-ability.ts:72](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/cancelable-ability.ts#L72)
129
+ [packages/ai-tool/src/utils/cancelable-ability.ts:72](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/cancelable-ability.ts#L72)
171
130
 
172
131
  ## Methods
173
132
 
174
- ### $cleanMultiTaskAborter
133
+ ### \_cleanMultiTaskAborter()
175
134
 
176
- ▸ **$cleanMultiTaskAborter**(`id`, `aborters`): `void`
135
+ > **\_cleanMultiTaskAborter**(`id`, `aborters`): `void`
177
136
 
178
137
  #### Parameters
179
138
 
180
- | Name | Type |
181
- | :------ | :------ |
182
- | `id` | [`AsyncTaskId`](../modules.md#asynctaskid) |
183
- | `aborters` | [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md) |
139
+ • **id**: [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
140
+
141
+ • **aborters**: [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md)
184
142
 
185
143
  #### Returns
186
144
 
@@ -188,41 +146,39 @@ ___
188
146
 
189
147
  #### Defined in
190
148
 
191
- [packages/ai-tool/src/utils/cancelable-ability.ts:214](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/cancelable-ability.ts#L214)
149
+ [packages/ai-tool/src/utils/cancelable-ability.ts:234](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/cancelable-ability.ts#L234)
192
150
 
193
- ___
151
+ ***
194
152
 
195
- ### $generateAsyncTaskId
153
+ ### \_generateAsyncTaskId()
196
154
 
197
- ▸ **$generateAsyncTaskId**(`taskId?`, `aborters?`): `undefined` \| [`AsyncTaskId`](../modules.md#asynctaskid)
155
+ > **\_generateAsyncTaskId**(`taskId`?, `aborters`?): [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
198
156
 
199
157
  #### Parameters
200
158
 
201
- | Name | Type |
202
- | :------ | :------ |
203
- | `taskId?` | [`AsyncTaskId`](../modules.md#asynctaskid) |
204
- | `aborters?` | [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md) |
159
+ • **taskId?**: [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
160
+
161
+ • **aborters?**: [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md)
205
162
 
206
163
  #### Returns
207
164
 
208
- `undefined` \| [`AsyncTaskId`](../modules.md#asynctaskid)
165
+ [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
209
166
 
210
167
  #### Defined in
211
168
 
212
- [packages/ai-tool/src/utils/cancelable-ability.ts:147](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/cancelable-ability.ts#L147)
169
+ [packages/ai-tool/src/utils/cancelable-ability.ts:134](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/cancelable-ability.ts#L134)
213
170
 
214
- ___
171
+ ***
215
172
 
216
- ### \_cleanMultiTaskAborter
173
+ ### $cleanMultiTaskAborter()
217
174
 
218
- ▸ **_cleanMultiTaskAborter**(`id`, `aborters`): `void`
175
+ > **$cleanMultiTaskAborter**(`id`, `aborters`): `void`
219
176
 
220
177
  #### Parameters
221
178
 
222
- | Name | Type |
223
- | :------ | :------ |
224
- | `id` | [`AsyncTaskId`](../modules.md#asynctaskid) |
225
- | `aborters` | [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md) |
179
+ • **id**: [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
180
+
181
+ • **aborters**: [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md)
226
182
 
227
183
  #### Returns
228
184
 
@@ -230,41 +186,39 @@ ___
230
186
 
231
187
  #### Defined in
232
188
 
233
- [packages/ai-tool/src/utils/cancelable-ability.ts:234](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/cancelable-ability.ts#L234)
189
+ [packages/ai-tool/src/utils/cancelable-ability.ts:214](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/cancelable-ability.ts#L214)
234
190
 
235
- ___
191
+ ***
236
192
 
237
- ### \_generateAsyncTaskId
193
+ ### $generateAsyncTaskId()
238
194
 
239
- ▸ **_generateAsyncTaskId**(`taskId?`, `aborters?`): [`AsyncTaskId`](../modules.md#asynctaskid)
195
+ > **$generateAsyncTaskId**(`taskId`?, `aborters`?): `undefined` \| [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
240
196
 
241
197
  #### Parameters
242
198
 
243
- | Name | Type |
244
- | :------ | :------ |
245
- | `taskId?` | [`AsyncTaskId`](../modules.md#asynctaskid) |
246
- | `aborters?` | [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md) |
199
+ • **taskId?**: [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
200
+
201
+ • **aborters?**: [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md)
247
202
 
248
203
  #### Returns
249
204
 
250
- [`AsyncTaskId`](../modules.md#asynctaskid)
205
+ `undefined` \| [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
251
206
 
252
207
  #### Defined in
253
208
 
254
- [packages/ai-tool/src/utils/cancelable-ability.ts:134](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/cancelable-ability.ts#L134)
209
+ [packages/ai-tool/src/utils/cancelable-ability.ts:147](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/cancelable-ability.ts#L147)
255
210
 
256
- ___
211
+ ***
257
212
 
258
- ### abort
213
+ ### abort()
259
214
 
260
- ▸ **abort**(`reason?`, `data?`): `void`
215
+ > **abort**(`reason`?, `data`?): `void`
261
216
 
262
217
  #### Parameters
263
218
 
264
- | Name | Type |
265
- | :------ | :------ |
266
- | `reason?` | `string` |
267
- | `data?` | `any` |
219
+ • **reason?**: `string`
220
+
221
+ • **data?**: `any`
268
222
 
269
223
  #### Returns
270
224
 
@@ -272,19 +226,17 @@ ___
272
226
 
273
227
  #### Defined in
274
228
 
275
- [packages/ai-tool/src/utils/cancelable-ability.ts:291](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/cancelable-ability.ts#L291)
229
+ [packages/ai-tool/src/utils/cancelable-ability.ts:291](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/cancelable-ability.ts#L291)
276
230
 
277
- ___
231
+ ***
278
232
 
279
- ### cleanTaskAborter
233
+ ### cleanTaskAborter()
280
234
 
281
- ▸ **cleanTaskAborter**(`aborter`): `void`
235
+ > **cleanTaskAborter**(`aborter`): `void`
282
236
 
283
237
  #### Parameters
284
238
 
285
- | Name | Type |
286
- | :------ | :------ |
287
- | `aborter` | [`TaskAbortController`](TaskAbortController.md) |
239
+ • **aborter**: [`TaskAbortController`](TaskAbortController.md)
288
240
 
289
241
  #### Returns
290
242
 
@@ -292,21 +244,21 @@ ___
292
244
 
293
245
  #### Defined in
294
246
 
295
- [packages/ai-tool/src/utils/cancelable-ability.ts:224](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/cancelable-ability.ts#L224)
247
+ [packages/ai-tool/src/utils/cancelable-ability.ts:224](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/cancelable-ability.ts#L224)
296
248
 
297
- ___
249
+ ***
298
250
 
299
- ### createAborter
251
+ ### createAborter()
300
252
 
301
- ▸ **createAborter**(`params?`, `taskId?`, `raiseError?`): [`TaskAbortController`](TaskAbortController.md)
253
+ > **createAborter**(`params`?, `taskId`?, `raiseError`?): [`TaskAbortController`](TaskAbortController.md)
302
254
 
303
255
  #### Parameters
304
256
 
305
- | Name | Type | Default value |
306
- | :------ | :------ | :------ |
307
- | `params?` | `any` | `undefined` |
308
- | `taskId?` | [`AsyncTaskId`](../modules.md#asynctaskid) | `undefined` |
309
- | `raiseError` | `boolean` | `true` |
257
+ • **params?**: `any`
258
+
259
+ • **taskId?**: [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
260
+
261
+ • **raiseError?**: `boolean` = `true`
310
262
 
311
263
  #### Returns
312
264
 
@@ -314,29 +266,29 @@ ___
314
266
 
315
267
  #### Defined in
316
268
 
317
- [packages/ai-tool/src/utils/cancelable-ability.ts:158](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/cancelable-ability.ts#L158)
269
+ [packages/ai-tool/src/utils/cancelable-ability.ts:158](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/cancelable-ability.ts#L158)
318
270
 
319
- ___
271
+ ***
320
272
 
321
- ### createTaskPromise
273
+ ### createTaskPromise()
322
274
 
323
- ▸ **createTaskPromise**\<`Output`\>(`runTask`, `params`, `options?`): [`TaskPromise`](../interfaces/TaskPromise.md)\<`Output`\>
275
+ > **createTaskPromise**\<`Output`\>(`runTask`, `params`, `options`?): [`TaskPromise`](../interfaces/TaskPromise.md)\<`Output`\>
324
276
 
325
- #### Type parameters
277
+ #### Type Parameters
326
278
 
327
- | Name | Type |
328
- | :------ | :------ |
329
- | `Output` | `any` |
279
+ • **Output** = `any`
330
280
 
331
281
  #### Parameters
332
282
 
333
- | Name | Type |
334
- | :------ | :------ |
335
- | `runTask` | (`params`: `Record`\<`string`, `any`\>, `aborter`: [`TaskAbortController`](TaskAbortController.md)) => `Promise`\<`Output`\> |
336
- | `params` | `Record`\<`string`, `any`\> |
337
- | `options?` | `Object` |
338
- | `options.raiseError?` | `boolean` |
339
- | `options.taskId?` | [`AsyncTaskId`](../modules.md#asynctaskid) |
283
+ • **runTask**
284
+
285
+ • **params**: `Record`\<`string`, `any`\>
286
+
287
+ • **options?**
288
+
289
+ • **options.raiseError?**: `boolean`
290
+
291
+ • **options.taskId?**: [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
340
292
 
341
293
  #### Returns
342
294
 
@@ -344,19 +296,17 @@ ___
344
296
 
345
297
  #### Defined in
346
298
 
347
- [packages/ai-tool/src/utils/cancelable-ability.ts:238](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/cancelable-ability.ts#L238)
299
+ [packages/ai-tool/src/utils/cancelable-ability.ts:238](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/cancelable-ability.ts#L238)
348
300
 
349
- ___
301
+ ***
350
302
 
351
- ### getRunningTask
303
+ ### getRunningTask()
352
304
 
353
- ▸ **getRunningTask**(`taskId?`): `undefined` \| [`TaskAbortController`](TaskAbortController.md)
305
+ > **getRunningTask**(`taskId`?): `undefined` \| [`TaskAbortController`](TaskAbortController.md)
354
306
 
355
307
  #### Parameters
356
308
 
357
- | Name | Type |
358
- | :------ | :------ |
359
- | `taskId?` | [`AsyncTaskId`](../modules.md#asynctaskid) |
309
+ • **taskId?**: [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
360
310
 
361
311
  #### Returns
362
312
 
@@ -364,13 +314,13 @@ ___
364
314
 
365
315
  #### Defined in
366
316
 
367
- [packages/ai-tool/src/utils/cancelable-ability.ts:96](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/cancelable-ability.ts#L96)
317
+ [packages/ai-tool/src/utils/cancelable-ability.ts:96](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/cancelable-ability.ts#L96)
368
318
 
369
- ___
319
+ ***
370
320
 
371
- ### getRunningTaskCount
321
+ ### getRunningTaskCount()
372
322
 
373
- ▸ **getRunningTaskCount**(): `number`
323
+ > **getRunningTaskCount**(): `number`
374
324
 
375
325
  #### Returns
376
326
 
@@ -378,19 +328,17 @@ ___
378
328
 
379
329
  #### Defined in
380
330
 
381
- [packages/ai-tool/src/utils/cancelable-ability.ts:119](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/cancelable-ability.ts#L119)
331
+ [packages/ai-tool/src/utils/cancelable-ability.ts:119](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/cancelable-ability.ts#L119)
382
332
 
383
- ___
333
+ ***
384
334
 
385
- ### isAborted
335
+ ### isAborted()
386
336
 
387
- ▸ **isAborted**(`taskId?`): `boolean`
337
+ > **isAborted**(`taskId`?): `boolean`
388
338
 
389
339
  #### Parameters
390
340
 
391
- | Name | Type |
392
- | :------ | :------ |
393
- | `taskId?` | [`AsyncTaskId`](../modules.md#asynctaskid) |
341
+ • **taskId?**: [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
394
342
 
395
343
  #### Returns
396
344
 
@@ -398,29 +346,29 @@ ___
398
346
 
399
347
  #### Defined in
400
348
 
401
- [packages/ai-tool/src/utils/cancelable-ability.ts:81](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/cancelable-ability.ts#L81)
349
+ [packages/ai-tool/src/utils/cancelable-ability.ts:81](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/cancelable-ability.ts#L81)
402
350
 
403
- ___
351
+ ***
404
352
 
405
- ### runAsyncCancelableTask
353
+ ### runAsyncCancelableTask()
406
354
 
407
- ▸ **runAsyncCancelableTask**\<`Output`\>(`params?`, `runTask`, `options?`): [`TaskPromise`](../interfaces/TaskPromise.md)\<`Output`\>
355
+ > **runAsyncCancelableTask**\<`Output`\>(`params`, `runTask`, `options`?): [`TaskPromise`](../interfaces/TaskPromise.md)\<`Output`\>
408
356
 
409
- #### Type parameters
357
+ #### Type Parameters
410
358
 
411
- | Name | Type |
412
- | :------ | :------ |
413
- | `Output` | `any` |
359
+ • **Output** = `any`
414
360
 
415
361
  #### Parameters
416
362
 
417
- | Name | Type |
418
- | :------ | :------ |
419
- | `params` | `Record`\<`string`, `any`\> |
420
- | `runTask` | (`params`: `Record`\<`string`, `any`\>, `aborter`: [`TaskAbortController`](TaskAbortController.md)) => `Promise`\<`Output`\> |
421
- | `options?` | `Object` |
422
- | `options.raiseError?` | `boolean` |
423
- | `options.taskId?` | [`AsyncTaskId`](../modules.md#asynctaskid) |
363
+ • **params**: `Record`\<`string`, `any`\> = `{}`
364
+
365
+ • **runTask**
366
+
367
+ • **options?**
368
+
369
+ • **options.raiseError?**: `boolean`
370
+
371
+ • **options.taskId?**: [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
424
372
 
425
373
  #### Returns
426
374
 
@@ -428,4 +376,4 @@ ___
428
376
 
429
377
  #### Defined in
430
378
 
431
- [packages/ai-tool/src/utils/cancelable-ability.ts:276](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/cancelable-ability.ts#L276)
379
+ [packages/ai-tool/src/utils/cancelable-ability.ts:276](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/cancelable-ability.ts#L276)