@isdk/ai-tool 0.5.1 → 0.5.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 (329) hide show
  1. package/package.json +1 -1
  2. package/docs/README.md +0 -250
  3. package/docs/_media/CONTRIBUTING.md +0 -18
  4. package/docs/_media/LICENSE-MIT +0 -22
  5. package/docs/classes/AbortError.md +0 -366
  6. package/docs/classes/AlreadyExistsError.md +0 -346
  7. package/docs/classes/BaseError.md +0 -359
  8. package/docs/classes/BinarySemaphore.md +0 -418
  9. package/docs/classes/CancelableAbility.md +0 -467
  10. package/docs/classes/ClientTools.md +0 -2715
  11. package/docs/classes/CommonError.md +0 -377
  12. package/docs/classes/ConfigFile.md +0 -353
  13. package/docs/classes/EnvPromptTemplate.md +0 -1158
  14. package/docs/classes/EventClient.md +0 -3149
  15. package/docs/classes/EventEmitter.md +0 -299
  16. package/docs/classes/EventServer.md +0 -3175
  17. package/docs/classes/EventToolFunc.md +0 -2557
  18. package/docs/classes/FStringPromptTemplate.md +0 -1158
  19. package/docs/classes/FewShotPromptTemplate.md +0 -1180
  20. package/docs/classes/GolangPromptTemplate.md +0 -1158
  21. package/docs/classes/HFEnvironment.md +0 -184
  22. package/docs/classes/HFInterpreter.md +0 -77
  23. package/docs/classes/HFTemplate.md +0 -67
  24. package/docs/classes/HfPromptTemplate.md +0 -1158
  25. package/docs/classes/IntSet.md +0 -216
  26. package/docs/classes/LRUCache.md +0 -601
  27. package/docs/classes/NotFoundError.md +0 -346
  28. package/docs/classes/NotImplementationError.md +0 -346
  29. package/docs/classes/PromptExampleSelector.md +0 -195
  30. package/docs/classes/PromptTemplate.md +0 -1088
  31. package/docs/classes/ReadableStreamError.md +0 -366
  32. package/docs/classes/ResClientTools.md +0 -2431
  33. package/docs/classes/ResServerTools.md +0 -2407
  34. package/docs/classes/SSEChannel.md +0 -270
  35. package/docs/classes/Semaphore.md +0 -538
  36. package/docs/classes/ServerTools.md +0 -2623
  37. package/docs/classes/SignalGate.md +0 -182
  38. package/docs/classes/TaskAbortController.md +0 -131
  39. package/docs/classes/ToolFunc.md +0 -2177
  40. package/docs/classes/YamlTypeBaseObject.md +0 -31
  41. package/docs/enumerations/AsyncFeatureBits.md +0 -33
  42. package/docs/enumerations/AsyncFeatures.md +0 -33
  43. package/docs/enumerations/ErrorCode.md +0 -177
  44. package/docs/enumerations/HashAlgorithm.md +0 -97
  45. package/docs/functions/AIArgProcessor.md +0 -33
  46. package/docs/functions/AIStream.md +0 -52
  47. package/docs/functions/ChoiceArgProcessor.md +0 -33
  48. package/docs/functions/ObjectArgsToArgsInfo.md +0 -29
  49. package/docs/functions/RateLimit.md +0 -37
  50. package/docs/functions/TemplateArgProcessor.md +0 -33
  51. package/docs/functions/assignDirs.md +0 -33
  52. package/docs/functions/backendEventable.md +0 -29
  53. package/docs/functions/beforeShutdown.md +0 -29
  54. package/docs/functions/canonicalize.md +0 -21
  55. package/docs/functions/completeSentences.md +0 -25
  56. package/docs/functions/concatText.md +0 -25
  57. package/docs/functions/countLLMTokens.md +0 -25
  58. package/docs/functions/countRegexMatches.md +0 -35
  59. package/docs/functions/createAbilityInjector.md +0 -119
  60. package/docs/functions/createCallbacksTransformer.md +0 -49
  61. package/docs/functions/createEmptyReadableStream.md +0 -21
  62. package/docs/functions/createEndWithRepetitionDetector.md +0 -31
  63. package/docs/functions/createError.md +0 -39
  64. package/docs/functions/createEventStreamTransformer.md +0 -33
  65. package/docs/functions/createHfValueFunc.md +0 -31
  66. package/docs/functions/createLRUCache.md +0 -25
  67. package/docs/functions/createYamlObjectTag.md +0 -25
  68. package/docs/functions/dateToText.md +0 -25
  69. package/docs/functions/decodeCharset.md +0 -25
  70. package/docs/functions/detectCharset.md +0 -25
  71. package/docs/functions/encodeLLMTokens.md +0 -25
  72. package/docs/functions/ensureQuoted.md +0 -25
  73. package/docs/functions/eventable.md +0 -82
  74. package/docs/functions/expandConfig.md +0 -25
  75. package/docs/functions/expandEnv.md +0 -40
  76. package/docs/functions/expandObjEnv.md +0 -58
  77. package/docs/functions/expandPath.md +0 -25
  78. package/docs/functions/extNameLevel.md +0 -43
  79. package/docs/functions/fileIsExists.md +0 -34
  80. package/docs/functions/filenameReservedRegex.md +0 -20
  81. package/docs/functions/filterValidFnScope.md +0 -21
  82. package/docs/functions/findIndexNonEmptyFrom.md +0 -25
  83. package/docs/functions/findPort.md +0 -25
  84. package/docs/functions/formatISO.md +0 -69
  85. package/docs/functions/formatTextWithSpace.md +0 -63
  86. package/docs/functions/getAllEnumKeys.md +0 -31
  87. package/docs/functions/getConfigFileNames.md +0 -25
  88. package/docs/functions/getConfigs.md +0 -25
  89. package/docs/functions/getEnvVairables.md +0 -21
  90. package/docs/functions/getFileMetaInfo.md +0 -21
  91. package/docs/functions/getHashAlgoBySize.md +0 -21
  92. package/docs/functions/getKeysPath.md +0 -38
  93. package/docs/functions/getLLMTokenizer.md +0 -21
  94. package/docs/functions/getMultiLevelExtname.md +0 -33
  95. package/docs/functions/getPackageDir.md +0 -39
  96. package/docs/functions/getRealFilepath.md +0 -34
  97. package/docs/functions/getResponseErrorReadableStream.md +0 -21
  98. package/docs/functions/getXDGConfigs.md +0 -37
  99. package/docs/functions/hasDirectoryIn.md +0 -40
  100. package/docs/functions/hash.md +0 -25
  101. package/docs/functions/hashFile.md +0 -25
  102. package/docs/functions/hashStream.md +0 -25
  103. package/docs/functions/hfParse.md +0 -24
  104. package/docs/functions/hfTokenize.md +0 -27
  105. package/docs/functions/initShutdown.md +0 -15
  106. package/docs/functions/interpolateEnv.md +0 -29
  107. package/docs/functions/interpolateFString.md +0 -29
  108. package/docs/functions/interpolateGolangTemplate.md +0 -35
  109. package/docs/functions/isLangUsingSpaces.md +0 -21
  110. package/docs/functions/isListItemString.md +0 -21
  111. package/docs/functions/isModelNameMatched.md +0 -47
  112. package/docs/functions/isPunctuationChar.md +0 -36
  113. package/docs/functions/isQuoted.md +0 -21
  114. package/docs/functions/isRegExp.md +0 -21
  115. package/docs/functions/isSameString.md +0 -36
  116. package/docs/functions/isSectionString.md +0 -25
  117. package/docs/functions/isSentenceEnding.md +0 -21
  118. package/docs/functions/isSepLineString.md +0 -21
  119. package/docs/functions/isStrWrapped.md +0 -25
  120. package/docs/functions/isSubdirectory.md +0 -41
  121. package/docs/functions/isTitleString.md +0 -25
  122. package/docs/functions/isValidFilename.md +0 -38
  123. package/docs/functions/isValidFilepath.md +0 -27
  124. package/docs/functions/isWebStream.md +0 -21
  125. package/docs/functions/jsonFilterToWhere.md +0 -47
  126. package/docs/functions/jsonToMarkdownStr.md +0 -39
  127. package/docs/functions/loadAIConfig.md +0 -21
  128. package/docs/functions/loadConfig.md +0 -25
  129. package/docs/functions/loadConfigFile.md +0 -25
  130. package/docs/functions/loadFileFromPaths.md +0 -64
  131. package/docs/functions/loadTextFromPaths.md +0 -37
  132. package/docs/functions/lrucache.md +0 -35
  133. package/docs/functions/makeToolFuncCancelable.md +0 -29
  134. package/docs/functions/matchUrlProtocol.md +0 -48
  135. package/docs/functions/memoize.md +0 -29
  136. package/docs/functions/messagesToText.md +0 -21
  137. package/docs/functions/paramsSizeToScaleStr.md +0 -34
  138. package/docs/functions/parseCommand.md +0 -29
  139. package/docs/functions/parseDateFormat.md +0 -362
  140. package/docs/functions/parseFString.md +0 -26
  141. package/docs/functions/parseISO.md +0 -70
  142. package/docs/functions/parseJsJson.md +0 -40
  143. package/docs/functions/parseJsJsonSimpleSync.md +0 -25
  144. package/docs/functions/parseObjectArgInfo.md +0 -33
  145. package/docs/functions/parseObjectArgumentInfos.md +0 -29
  146. package/docs/functions/parseObjectArguments.md +0 -72
  147. package/docs/functions/parseObjectArgumentsAsArgInfos.md +0 -46
  148. package/docs/functions/parseYaml.md +0 -25
  149. package/docs/functions/quoteStr.md +0 -21
  150. package/docs/functions/reControlCharsRegex.md +0 -19
  151. package/docs/functions/readFilenamesRecursiveSync.md +0 -53
  152. package/docs/functions/readTextFileChunks.md +0 -53
  153. package/docs/functions/readTextFileChunksEx.md +0 -25
  154. package/docs/functions/readableFromAsyncIterable.md +0 -28
  155. package/docs/functions/registerCoreTools.md +0 -15
  156. package/docs/functions/registerYamlTag.md +0 -21
  157. package/docs/functions/removeMarkdownBold.md +0 -25
  158. package/docs/functions/removeMarkdownBoldAndItalic.md +0 -25
  159. package/docs/functions/removeMarkdownItalic.md +0 -25
  160. package/docs/functions/replaceWithPlaceholder.md +0 -43
  161. package/docs/functions/restoreFromPlacehoders.md +0 -49
  162. package/docs/functions/sanitizeFilename.md +0 -39
  163. package/docs/functions/sanitizeFilepath.md +0 -33
  164. package/docs/functions/saveConfigFile.md +0 -29
  165. package/docs/functions/scaleStrToParamsSize.md +0 -27
  166. package/docs/functions/shutdown.md +0 -33
  167. package/docs/functions/simplifyObjectArguments.md +0 -21
  168. package/docs/functions/sortedValues.md +0 -25
  169. package/docs/functions/splitChunks.md +0 -25
  170. package/docs/functions/splitParagraph.md +0 -34
  171. package/docs/functions/splitSentence.md +0 -39
  172. package/docs/functions/stringifyYaml.md +0 -25
  173. package/docs/functions/stripConsoleColor.md +0 -21
  174. package/docs/functions/textToDate.md +0 -25
  175. package/docs/functions/throwError.md +0 -41
  176. package/docs/functions/toDate.md +0 -74
  177. package/docs/functions/toDateTime.md +0 -21
  178. package/docs/functions/toRegExp.md +0 -34
  179. package/docs/functions/trimStartOfStreamHelper.md +0 -41
  180. package/docs/functions/truncTo.md +0 -51
  181. package/docs/functions/truncateByToken.md +0 -25
  182. package/docs/functions/truncateToTokenLimit.md +0 -46
  183. package/docs/functions/truncateToTokenLimitEx.md +0 -25
  184. package/docs/functions/uuid.md +0 -25
  185. package/docs/functions/uuidParse.md +0 -21
  186. package/docs/functions/uuidStringify.md +0 -25
  187. package/docs/functions/uuidValidate.md +0 -21
  188. package/docs/functions/uuidVersion.md +0 -21
  189. package/docs/functions/uuidv1.md +0 -55
  190. package/docs/functions/uuidv4.md +0 -55
  191. package/docs/functions/uuidv5.md +0 -63
  192. package/docs/functions/wait.md +0 -21
  193. package/docs/functions/wrapEventEmitter.md +0 -27
  194. package/docs/functions/xxhash.md +0 -29
  195. package/docs/functions/xxhash32.md +0 -25
  196. package/docs/functions/xxhash64.md +0 -25
  197. package/docs/functions/xxhashAsStr.md +0 -29
  198. package/docs/globals.md +0 -329
  199. package/docs/interfaces/AIChatAssistantMessageParam.md +0 -129
  200. package/docs/interfaces/AIChatContentPartImage.md +0 -29
  201. package/docs/interfaces/AIChatContentPartText.md +0 -25
  202. package/docs/interfaces/AIChatMessageParamBase.md +0 -68
  203. package/docs/interfaces/AIChatMessageToolCall.md +0 -41
  204. package/docs/interfaces/AIChatSystemMessageParam.md +0 -105
  205. package/docs/interfaces/AIChatToolChoiceFuncObject.md +0 -37
  206. package/docs/interfaces/AIChatToolChoiceObject.md +0 -25
  207. package/docs/interfaces/AIChatToolFunc.md +0 -41
  208. package/docs/interfaces/AIChatToolFuncParam.md +0 -37
  209. package/docs/interfaces/AIChatToolMessageParam.md +0 -113
  210. package/docs/interfaces/AIChatToolParam.md +0 -25
  211. package/docs/interfaces/AIChatToolTypeObject.md +0 -17
  212. package/docs/interfaces/AIChatUserMessageParam.md +0 -137
  213. package/docs/interfaces/AIChoiceConfig.md +0 -65
  214. package/docs/interfaces/AIResult.md +0 -65
  215. package/docs/interfaces/AIStreamParser.md +0 -43
  216. package/docs/interfaces/AIStreamParserOptions.md +0 -21
  217. package/docs/interfaces/BaseFunc.md +0 -145
  218. package/docs/interfaces/BaseFuncItem.md +0 -93
  219. package/docs/interfaces/BinarySemaphoreAcquireOptions.md +0 -25
  220. package/docs/interfaces/BinarySemaphoreOptions.md +0 -57
  221. package/docs/interfaces/BinarySemaphoreReleaseOptions.md +0 -25
  222. package/docs/interfaces/BinarySemaphoreReleaserFunc.md +0 -37
  223. package/docs/interfaces/CancelableAbilityOptions.md +0 -113
  224. package/docs/interfaces/ClientFuncItem.md +0 -163
  225. package/docs/interfaces/DotenvExpandOptions.md +0 -43
  226. package/docs/interfaces/DotenvExpandOutput.md +0 -25
  227. package/docs/interfaces/DotenvParseInput.md +0 -13
  228. package/docs/interfaces/DotenvParseOutput.md +0 -13
  229. package/docs/interfaces/DotenvPopulateInput.md +0 -13
  230. package/docs/interfaces/EventClientFuncParams.md +0 -51
  231. package/docs/interfaces/EventServerFuncParams.md +0 -67
  232. package/docs/interfaces/FewShotPromptTemplateOptions.md +0 -147
  233. package/docs/interfaces/FuncItem.md +0 -131
  234. package/docs/interfaces/FuncParam.md +0 -61
  235. package/docs/interfaces/FuncParams.md +0 -13
  236. package/docs/interfaces/Funcs.md +0 -13
  237. package/docs/interfaces/HashAlgoParams.md +0 -33
  238. package/docs/interfaces/IFileMetaInfo.md +0 -65
  239. package/docs/interfaces/IReadTextFileChunksOptions.md +0 -143
  240. package/docs/interfaces/ITruncateToTokenLimitOptions.md +0 -99
  241. package/docs/interfaces/JsonFilter.md +0 -13
  242. package/docs/interfaces/ParseObjectArgumentOptions.md +0 -89
  243. package/docs/interfaces/PromptExampleSelectorOptions.md +0 -34
  244. package/docs/interfaces/PromptTemplateOptions.md +0 -65
  245. package/docs/interfaces/RemoteFuncItem.md +0 -152
  246. package/docs/interfaces/ReplacePlacehoderOptions.md +0 -41
  247. package/docs/interfaces/ResClientFuncParams.md +0 -37
  248. package/docs/interfaces/ResServerFuncParams.md +0 -69
  249. package/docs/interfaces/SanitizeFilenameOptions.md +0 -25
  250. package/docs/interfaces/SectionStringOptions.md +0 -25
  251. package/docs/interfaces/SemaphoreOptions.md +0 -89
  252. package/docs/interfaces/SemaphoreTaskItem.md +0 -73
  253. package/docs/interfaces/ServerFuncItem.md +0 -171
  254. package/docs/interfaces/ServerFuncParams.md +0 -35
  255. package/docs/interfaces/SplitSentenceOptions.md +0 -41
  256. package/docs/interfaces/StreamCallbacksAndOptions.md +0 -99
  257. package/docs/interfaces/TaskAbortControllers.md +0 -13
  258. package/docs/interfaces/TaskPromise.md +0 -138
  259. package/docs/interfaces/ToolFuncPackage.md +0 -47
  260. package/docs/namespaces/EventStates/README.md +0 -14
  261. package/docs/namespaces/EventStates/variables/ABORT.md +0 -11
  262. package/docs/namespaces/EventStates/variables/CONTINUE.md +0 -11
  263. package/docs/namespaces/EventStates/variables/DONE.md +0 -11
  264. package/docs/namespaces/EventStates/variables/STOPPED.md +0 -11
  265. package/docs/namespaces/uuidv5/README.md +0 -12
  266. package/docs/namespaces/uuidv5/variables/DNS.md +0 -11
  267. package/docs/namespaces/uuidv5/variables/URL.md +0 -11
  268. package/docs/type-aliases/AIChatContentPart.md +0 -11
  269. package/docs/type-aliases/AIChatMessageParam.md +0 -11
  270. package/docs/type-aliases/AIChatRole.md +0 -11
  271. package/docs/type-aliases/AIChatToolChoiceParam.md +0 -11
  272. package/docs/type-aliases/AIMessageType.md +0 -11
  273. package/docs/type-aliases/AIModelNameRule.md +0 -11
  274. package/docs/type-aliases/AIModelNameRuleFn.md +0 -21
  275. package/docs/type-aliases/AIModelNameRules.md +0 -11
  276. package/docs/type-aliases/AITextGenerationFinishReason.md +0 -11
  277. package/docs/type-aliases/ActionName.md +0 -11
  278. package/docs/type-aliases/AsyncTaskId.md +0 -11
  279. package/docs/type-aliases/BeforeShutdownListener.md +0 -23
  280. package/docs/type-aliases/EventErrorListenerFn.md +0 -33
  281. package/docs/type-aliases/EventListenerFn.md +0 -29
  282. package/docs/type-aliases/FStringPromptTemplateNode.md +0 -14
  283. package/docs/type-aliases/FuncParamType.md +0 -11
  284. package/docs/type-aliases/PromptExamples.md +0 -15
  285. package/docs/type-aliases/PromptTemplateType.md +0 -11
  286. package/docs/type-aliases/PromptType.md +0 -11
  287. package/docs/type-aliases/SemaphoreIsReadyFuncType.md +0 -15
  288. package/docs/type-aliases/TFunc.md +0 -25
  289. package/docs/variables/AIChatRoles.md +0 -11
  290. package/docs/variables/AIMessageTypes.md +0 -11
  291. package/docs/variables/AITextGenerationFinishReasons.md +0 -11
  292. package/docs/variables/AbortErrorCode.md +0 -11
  293. package/docs/variables/ActionNames.md +0 -11
  294. package/docs/variables/AlreadyExistsErrorCode.md +0 -11
  295. package/docs/variables/ClientToolFuncSchema.md +0 -101
  296. package/docs/variables/DEFAULT_CONFIG_NAME.md +0 -11
  297. package/docs/variables/DefaultAsyncSemaphoreCapacity.md +0 -11
  298. package/docs/variables/EventBusName.md +0 -11
  299. package/docs/variables/EventName.md +0 -11
  300. package/docs/variables/FilenameReservedRegex.md +0 -14
  301. package/docs/variables/HFBuiltins.md +0 -122
  302. package/docs/variables/InternalErrorCode.md +0 -11
  303. package/docs/variables/LLM_TOKENIZER_NAMES.md +0 -81
  304. package/docs/variables/LLM_TOKENIZER_NAMES_MAP.md +0 -11
  305. package/docs/variables/NotFoundErrorCode.md +0 -11
  306. package/docs/variables/NotImplementedErrorCode.md +0 -11
  307. package/docs/variables/PASSING_SCORE.md +0 -11
  308. package/docs/variables/PromptTemplateTypes.md +0 -11
  309. package/docs/variables/PromptTypes.md +0 -14
  310. package/docs/variables/RStreamErrCode.md +0 -11
  311. package/docs/variables/RemoteToolFuncSchema.md +0 -101
  312. package/docs/variables/ResponseRStreamErrCode.md +0 -11
  313. package/docs/variables/SHUTDOWN_SIGNALS.md +0 -17
  314. package/docs/variables/SSEChannelAlreadyClosedErrCode.md +0 -11
  315. package/docs/variables/SecondaryCache.md +0 -11
  316. package/docs/variables/ServerToolFuncSchema.md +0 -101
  317. package/docs/variables/ToolAsyncCancelableBit.md +0 -11
  318. package/docs/variables/ToolAsyncMultiTaskBit.md +0 -11
  319. package/docs/variables/ToolAsyncPriorityBit.md +0 -11
  320. package/docs/variables/ToolFuncSchema.md +0 -133
  321. package/docs/variables/WindowsReservedNameRegex.md +0 -13
  322. package/docs/variables/base32768.md +0 -11
  323. package/docs/variables/defaultTemplateFormat.md +0 -11
  324. package/docs/variables/event.md +0 -11
  325. package/docs/variables/eventClient.md +0 -11
  326. package/docs/variables/eventServer.md +0 -11
  327. package/docs/variables/lrucache.md +0 -11
  328. package/docs/variables/mimeType.md +0 -11
  329. package/docs/variables/uuidNIL.md +0 -11
package/docs/classes/CancelableAbility.md DELETED
@@ -1,467 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md)
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / CancelableAbility
6
-
7
- # Class: CancelableAbility
8
-
9
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:74](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/cancelable-ability.ts#L74)
10
-
11
- ## Indexable
12
-
13
- \[`name`: `string`\]: `any`
14
-
15
- ## Constructors
16
-
17
- ### new CancelableAbility()
18
-
19
- > **new CancelableAbility**(): [`CancelableAbility`](CancelableAbility.md)
20
-
21
- #### Returns
22
-
23
- [`CancelableAbility`](CancelableAbility.md)
24
-
25
- ## Properties
26
-
27
- ### \_\_task\_aborter
28
-
29
- > **\_\_task\_aborter**: `undefined` \| [`TaskAbortController`](TaskAbortController.md) \| [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md)
30
-
31
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:86](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/cancelable-ability.ts#L86)
32
-
33
- ***
34
-
35
- ### \_\_task\_semaphore
36
-
37
- > **\_\_task\_semaphore**: `undefined` \| [`Semaphore`](Semaphore.md)
38
-
39
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:87](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/cancelable-ability.ts#L87)
40
-
41
- ***
42
-
43
- ### \_asyncFeatures?
44
-
45
- > `optional` **\_asyncFeatures**: `number`
46
-
47
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:75](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/cancelable-ability.ts#L75)
48
-
49
- ***
50
-
51
- ### \_isReadyFn?
52
-
53
- > `optional` **\_isReadyFn**: [`SemaphoreIsReadyFuncType`](../type-aliases/SemaphoreIsReadyFuncType.md)
54
-
55
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:77](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/cancelable-ability.ts#L77)
56
-
57
- ***
58
-
59
- ### \_maxTaskConcurrency
60
-
61
- > **\_maxTaskConcurrency**: `undefined` \| `number`
62
-
63
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:76](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/cancelable-ability.ts#L76)
64
-
65
- ***
66
-
67
- ### cleanMultiTaskAborter()
68
-
69
- > **cleanMultiTaskAborter**: (`id`, `aborters`) => `void`
70
-
71
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:84](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/cancelable-ability.ts#L84)
72
-
73
- #### Parameters
74
-
75
- ##### id
76
-
77
- [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
78
-
79
- ##### aborters
80
-
81
- [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md)
82
-
83
- #### Returns
84
-
85
- `void`
86
-
87
- ***
88
-
89
- ### generateAsyncTaskId()
90
-
91
- > **generateAsyncTaskId**: (`taskId`?, `aborters`?) => [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
92
-
93
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:83](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/cancelable-ability.ts#L83)
94
-
95
- #### Parameters
96
-
97
- ##### taskId?
98
-
99
- [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
100
-
101
- ##### aborters?
102
-
103
- [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md)
104
-
105
- #### Returns
106
-
107
- [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
108
-
109
- ## Accessors
110
-
111
- ### maxTaskConcurrency
112
-
113
- #### Get Signature
114
-
115
- > **get** **maxTaskConcurrency**(): `undefined` \| `number`
116
-
117
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:89](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/cancelable-ability.ts#L89)
118
-
119
- ##### Returns
120
-
121
- `undefined` \| `number`
122
-
123
- ***
124
-
125
- ### semaphore
126
-
127
- #### Get Signature
128
-
129
- > **get** **semaphore**(): `undefined` \| [`Semaphore`](Semaphore.md)
130
-
131
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:93](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/cancelable-ability.ts#L93)
132
-
133
- ##### Returns
134
-
135
- `undefined` \| [`Semaphore`](Semaphore.md)
136
-
137
- ## Methods
138
-
139
- ### \_cleanMultiTaskAborter()
140
-
141
- > **\_cleanMultiTaskAborter**(`id`, `aborters`): `void`
142
-
143
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:273](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/cancelable-ability.ts#L273)
144
-
145
- #### Parameters
146
-
147
- ##### id
148
-
149
- [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
150
-
151
- ##### aborters
152
-
153
- [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md)
154
-
155
- #### Returns
156
-
157
- `void`
158
-
159
- ***
160
-
161
- ### \_generateAsyncTaskId()
162
-
163
- > **\_generateAsyncTaskId**(`taskId`?, `aborters`?): [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
164
-
165
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:173](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/cancelable-ability.ts#L173)
166
-
167
- #### Parameters
168
-
169
- ##### taskId?
170
-
171
- [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
172
-
173
- ##### aborters?
174
-
175
- [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md)
176
-
177
- #### Returns
178
-
179
- [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
180
-
181
- ***
182
-
183
- ### $cleanMultiTaskAborter()
184
-
185
- > **$cleanMultiTaskAborter**(`id`, `aborters`): `void`
186
-
187
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:253](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/cancelable-ability.ts#L253)
188
-
189
- #### Parameters
190
-
191
- ##### id
192
-
193
- [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
194
-
195
- ##### aborters
196
-
197
- [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md)
198
-
199
- #### Returns
200
-
201
- `void`
202
-
203
- ***
204
-
205
- ### $generateAsyncTaskId()
206
-
207
- > **$generateAsyncTaskId**(`taskId`?, `aborters`?): `undefined` \| [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
208
-
209
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:186](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/cancelable-ability.ts#L186)
210
-
211
- #### Parameters
212
-
213
- ##### taskId?
214
-
215
- [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
216
-
217
- ##### aborters?
218
-
219
- [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md)
220
-
221
- #### Returns
222
-
223
- `undefined` \| [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
224
-
225
- ***
226
-
227
- ### abort()
228
-
229
- > **abort**(`reason`?, `data`?): `void`
230
-
231
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:330](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/cancelable-ability.ts#L330)
232
-
233
- #### Parameters
234
-
235
- ##### reason?
236
-
237
- `string`
238
-
239
- ##### data?
240
-
241
- `any`
242
-
243
- #### Returns
244
-
245
- `void`
246
-
247
- ***
248
-
249
- ### cleanTaskAborter()
250
-
251
- > **cleanTaskAborter**(`aborter`): `void`
252
-
253
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:263](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/cancelable-ability.ts#L263)
254
-
255
- #### Parameters
256
-
257
- ##### aborter
258
-
259
- [`TaskAbortController`](TaskAbortController.md)
260
-
261
- #### Returns
262
-
263
- `void`
264
-
265
- ***
266
-
267
- ### createAborter()
268
-
269
- > **createAborter**(`params`?, `taskId`?, `raiseError`?): [`TaskAbortController`](TaskAbortController.md)
270
-
271
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:197](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/cancelable-ability.ts#L197)
272
-
273
- #### Parameters
274
-
275
- ##### params?
276
-
277
- `any`
278
-
279
- ##### taskId?
280
-
281
- [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
282
-
283
- ##### raiseError?
284
-
285
- `boolean` = `true`
286
-
287
- #### Returns
288
-
289
- [`TaskAbortController`](TaskAbortController.md)
290
-
291
- ***
292
-
293
- ### createTaskPromise()
294
-
295
- > **createTaskPromise**\<`Output`\>(`runTask`, `params`, `options`?): [`TaskPromise`](../interfaces/TaskPromise.md)\<`Output`\>
296
-
297
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:277](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/cancelable-ability.ts#L277)
298
-
299
- #### Type Parameters
300
-
301
- • **Output** = `any`
302
-
303
- #### Parameters
304
-
305
- ##### runTask
306
-
307
- (`params`, `aborter`) => `Promise`\<`Output`\>
308
-
309
- ##### params
310
-
311
- `Record`\<`string`, `any`\>
312
-
313
- ##### options?
314
-
315
- ###### raiseError?
316
-
317
- `boolean`
318
-
319
- ###### taskId?
320
-
321
- [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
322
-
323
- #### Returns
324
-
325
- [`TaskPromise`](../interfaces/TaskPromise.md)\<`Output`\>
326
-
327
- ***
328
-
329
- ### getRunningTask()
330
-
331
- > **getRunningTask**(`taskId`?): `undefined` \| [`TaskAbortController`](TaskAbortController.md)
332
-
333
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:135](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/cancelable-ability.ts#L135)
334
-
335
- #### Parameters
336
-
337
- ##### taskId?
338
-
339
- [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
340
-
341
- #### Returns
342
-
343
- `undefined` \| [`TaskAbortController`](TaskAbortController.md)
344
-
345
- ***
346
-
347
- ### getRunningTaskCount()
348
-
349
- > **getRunningTaskCount**(): `number`
350
-
351
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:158](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/cancelable-ability.ts#L158)
352
-
353
- #### Returns
354
-
355
- `number`
356
-
357
- ***
358
-
359
- ### getSemaphore()
360
-
361
- > **getSemaphore**(`isReadyFn`): `undefined` \| [`Semaphore`](Semaphore.md)
362
-
363
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:97](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/cancelable-ability.ts#L97)
364
-
365
- #### Parameters
366
-
367
- ##### isReadyFn
368
-
369
- `undefined` | [`SemaphoreIsReadyFuncType`](../type-aliases/SemaphoreIsReadyFuncType.md)
370
-
371
- #### Returns
372
-
373
- `undefined` \| [`Semaphore`](Semaphore.md)
374
-
375
- ***
376
-
377
- ### hasAsyncFeature()
378
-
379
- > **hasAsyncFeature**(`feature`): `boolean`
380
-
381
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:114](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/cancelable-ability.ts#L114)
382
-
383
- #### Parameters
384
-
385
- ##### feature
386
-
387
- [`AsyncFeatureBits`](../enumerations/AsyncFeatureBits.md)
388
-
389
- #### Returns
390
-
391
- `boolean`
392
-
393
- ***
394
-
395
- ### isAborted()
396
-
397
- > **isAborted**(`taskId`?): `boolean`
398
-
399
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:120](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/cancelable-ability.ts#L120)
400
-
401
- #### Parameters
402
-
403
- ##### taskId?
404
-
405
- [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
406
-
407
- #### Returns
408
-
409
- `boolean`
410
-
411
- ***
412
-
413
- ### runAsyncCancelableTask()
414
-
415
- > **runAsyncCancelableTask**\<`Output`\>(`params`, `runTask`, `options`?): [`TaskPromise`](../interfaces/TaskPromise.md)\<`Output`\>
416
-
417
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:315](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/cancelable-ability.ts#L315)
418
-
419
- #### Type Parameters
420
-
421
- • **Output** = `any`
422
-
423
- #### Parameters
424
-
425
- ##### params
426
-
427
- `Record`\<`string`, `any`\> = `{}`
428
-
429
- ##### runTask
430
-
431
- (`params`, `aborter`) => `Promise`\<`Output`\>
432
-
433
- ##### options?
434
-
435
- ###### isReadyFn?
436
-
437
- [`SemaphoreIsReadyFuncType`](../type-aliases/SemaphoreIsReadyFuncType.md)
438
-
439
- ###### raiseError?
440
-
441
- `boolean`
442
-
443
- ###### taskId?
444
-
445
- [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
446
-
447
- #### Returns
448
-
449
- [`TaskPromise`](../interfaces/TaskPromise.md)\<`Output`\>
450
-
451
- ***
452
-
453
- ### hasAsyncFeature()
454
-
455
- > `static` **hasAsyncFeature**(`feature`): `boolean`
456
-
457
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:107](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/cancelable-ability.ts#L107)
458
-
459
- #### Parameters
460
-
461
- ##### feature
462
-
463
- [`AsyncFeatureBits`](../enumerations/AsyncFeatureBits.md)
464
-
465
- #### Returns
466
-
467
- `boolean`