@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/interfaces/AIStreamParser.md DELETED
@@ -1,43 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md)
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / AIStreamParser
6
-
7
- # Interface: AIStreamParser()\<T, TOptions\>
8
-
9
- Defined in: [packages/ai-tool/src/utils/stream/ai-stream.ts:25](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/stream/ai-stream.ts#L25)
10
-
11
- Custom parser for AIStream data.
12
-
13
- ## Type Parameters
14
-
15
- • **T** = `any`
16
-
17
- • **TOptions** = `any`
18
-
19
- > **AIStreamParser**(`data`, `options`): `void` \| [`AIResult`](AIResult.md)\<`T`, `TOptions`\>
20
-
21
- Defined in: [packages/ai-tool/src/utils/stream/ai-stream.ts:26](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/stream/ai-stream.ts#L26)
22
-
23
- Custom parser for AIStream data.
24
-
25
- ## Parameters
26
-
27
- ### data
28
-
29
- `string`
30
-
31
- The data to be parsed.
32
-
33
- ### options
34
-
35
- [`AIStreamParserOptions`](AIStreamParserOptions.md)
36
-
37
- The options for the parser.
38
-
39
- ## Returns
40
-
41
- `void` \| [`AIResult`](AIResult.md)\<`T`, `TOptions`\>
42
-
43
- The parsed data or void.
package/docs/interfaces/AIStreamParserOptions.md DELETED
@@ -1,21 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md)
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / AIStreamParserOptions
6
-
7
- # Interface: AIStreamParserOptions
8
-
9
- Defined in: [packages/ai-tool/src/utils/stream/ai-stream.ts:14](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/stream/ai-stream.ts#L14)
10
-
11
- Options for the AIStreamParser.
12
-
13
- ## Properties
14
-
15
- ### event?
16
-
17
- > `optional` **event**: `string`
18
-
19
- Defined in: [packages/ai-tool/src/utils/stream/ai-stream.ts:15](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/stream/ai-stream.ts#L15)
20
-
21
- The event (type) from the server side event stream.
package/docs/interfaces/BaseFunc.md DELETED
@@ -1,145 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md)
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / BaseFunc
6
-
7
- # Interface: BaseFunc
8
-
9
- Defined in: [packages/ai-tool/src/tool-func.ts:37](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/tool-func.ts#L37)
10
-
11
- ## Extends
12
-
13
- - [`BaseFuncItem`](BaseFuncItem.md)
14
-
15
- ## Extended by
16
-
17
- - [`ToolFunc`](../classes/ToolFunc.md)
18
-
19
- ## Properties
20
-
21
- ### isApi?
22
-
23
- > `optional` **isApi**: `boolean`
24
-
25
- Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/tool-func.ts#L29)
26
-
27
- #### Inherited from
28
-
29
- [`BaseFuncItem`](BaseFuncItem.md).[`isApi`](BaseFuncItem.md#isapi)
30
-
31
- ***
32
-
33
- ### name?
34
-
35
- > `optional` **name**: `string`
36
-
37
- Defined in: [packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/tool-func.ts#L23)
38
-
39
- #### Inherited from
40
-
41
- [`BaseFuncItem`](BaseFuncItem.md).[`name`](BaseFuncItem.md#name)
42
-
43
- ***
44
-
45
- ### params?
46
-
47
- > `optional` **params**: [`FuncParams`](FuncParams.md) \| [`FuncParam`](FuncParam.md)[]
48
-
49
- Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/tool-func.ts#L24)
50
-
51
- #### Inherited from
52
-
53
- [`BaseFuncItem`](BaseFuncItem.md).[`params`](BaseFuncItem.md#params)
54
-
55
- ***
56
-
57
- ### result?
58
-
59
- > `optional` **result**: `string`
60
-
61
- Defined in: [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/tool-func.ts#L25)
62
-
63
- #### Inherited from
64
-
65
- [`BaseFuncItem`](BaseFuncItem.md).[`result`](BaseFuncItem.md#result)
66
-
67
- ***
68
-
69
- ### scope?
70
-
71
- > `optional` **scope**: `any`
72
-
73
- Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/tool-func.ts#L26)
74
-
75
- #### Inherited from
76
-
77
- [`BaseFuncItem`](BaseFuncItem.md).[`scope`](BaseFuncItem.md#scope)
78
-
79
- ***
80
-
81
- ### setup()?
82
-
83
- > `optional` **setup**: (`this`, `options`?) => `void`
84
-
85
- Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/tool-func.ts#L28)
86
-
87
- #### Parameters
88
-
89
- ##### this
90
-
91
- [`ToolFunc`](../classes/ToolFunc.md)
92
-
93
- ##### options?
94
-
95
- [`FuncItem`](FuncItem.md)
96
-
97
- #### Returns
98
-
99
- `void`
100
-
101
- #### Inherited from
102
-
103
- [`BaseFuncItem`](BaseFuncItem.md).[`setup`](BaseFuncItem.md#setup)
104
-
105
- ***
106
-
107
- ### stream?
108
-
109
- > `optional` **stream**: `boolean`
110
-
111
- Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/tool-func.ts#L30)
112
-
113
- #### Inherited from
114
-
115
- [`BaseFuncItem`](BaseFuncItem.md).[`stream`](BaseFuncItem.md#stream)
116
-
117
- ***
118
-
119
- ### tags?
120
-
121
- > `optional` **tags**: `string` \| `string`[]
122
-
123
- Defined in: [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/tool-func.ts#L27)
124
-
125
- #### Inherited from
126
-
127
- [`BaseFuncItem`](BaseFuncItem.md).[`tags`](BaseFuncItem.md#tags)
128
-
129
- ## Methods
130
-
131
- ### func()
132
-
133
- > **func**(...`params`): `any`
134
-
135
- Defined in: [packages/ai-tool/src/tool-func.ts:38](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/tool-func.ts#L38)
136
-
137
- #### Parameters
138
-
139
- ##### params
140
-
141
- ...`any`
142
-
143
- #### Returns
144
-
145
- `any`
package/docs/interfaces/BaseFuncItem.md DELETED
@@ -1,93 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md)
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / BaseFuncItem
6
-
7
- # Interface: BaseFuncItem
8
-
9
- Defined in: [packages/ai-tool/src/tool-func.ts:22](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/tool-func.ts#L22)
10
-
11
- ## Extended by
12
-
13
- - [`RemoteFuncItem`](RemoteFuncItem.md)
14
- - [`FuncItem`](FuncItem.md)
15
- - [`BaseFunc`](BaseFunc.md)
16
-
17
- ## Properties
18
-
19
- ### isApi?
20
-
21
- > `optional` **isApi**: `boolean`
22
-
23
- Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/tool-func.ts#L29)
24
-
25
- ***
26
-
27
- ### name?
28
-
29
- > `optional` **name**: `string`
30
-
31
- Defined in: [packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/tool-func.ts#L23)
32
-
33
- ***
34
-
35
- ### params?
36
-
37
- > `optional` **params**: [`FuncParams`](FuncParams.md) \| [`FuncParam`](FuncParam.md)[]
38
-
39
- Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/tool-func.ts#L24)
40
-
41
- ***
42
-
43
- ### result?
44
-
45
- > `optional` **result**: `string`
46
-
47
- Defined in: [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/tool-func.ts#L25)
48
-
49
- ***
50
-
51
- ### scope?
52
-
53
- > `optional` **scope**: `any`
54
-
55
- Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/tool-func.ts#L26)
56
-
57
- ***
58
-
59
- ### setup()?
60
-
61
- > `optional` **setup**: (`this`, `options`?) => `void`
62
-
63
- Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/tool-func.ts#L28)
64
-
65
- #### Parameters
66
-
67
- ##### this
68
-
69
- [`ToolFunc`](../classes/ToolFunc.md)
70
-
71
- ##### options?
72
-
73
- [`FuncItem`](FuncItem.md)
74
-
75
- #### Returns
76
-
77
- `void`
78
-
79
- ***
80
-
81
- ### stream?
82
-
83
- > `optional` **stream**: `boolean`
84
-
85
- Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/tool-func.ts#L30)
86
-
87
- ***
88
-
89
- ### tags?
90
-
91
- > `optional` **tags**: `string` \| `string`[]
92
-
93
- Defined in: [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/tool-func.ts#L27)
package/docs/interfaces/BinarySemaphoreAcquireOptions.md DELETED
@@ -1,25 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md)
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / BinarySemaphoreAcquireOptions
6
-
7
- # Interface: BinarySemaphoreAcquireOptions
8
-
9
- Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:28](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/async-semaphore.ts#L28)
10
-
11
- ## Extended by
12
-
13
- - [`SemaphoreTaskItem`](SemaphoreTaskItem.md)
14
-
15
- ## Indexable
16
-
17
- \[`n`: `string`\]: `any`
18
-
19
- ## Properties
20
-
21
- ### signal?
22
-
23
- > `optional` **signal**: `AbortSignal`
24
-
25
- Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:29](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/async-semaphore.ts#L29)
package/docs/interfaces/BinarySemaphoreOptions.md DELETED
@@ -1,57 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md)
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / BinarySemaphoreOptions
6
-
7
- # Interface: BinarySemaphoreOptions
8
-
9
- Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:21](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/async-semaphore.ts#L21)
10
-
11
- ## Extended by
12
-
13
- - [`SemaphoreOptions`](SemaphoreOptions.md)
14
-
15
- ## Properties
16
-
17
- ### capacity?
18
-
19
- > `optional` **capacity**: `number`
20
-
21
- Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:25](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/async-semaphore.ts#L25)
22
-
23
- ***
24
-
25
- ### initFn()?
26
-
27
- > `optional` **initFn**: () => `any`
28
-
29
- Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:22](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/async-semaphore.ts#L22)
30
-
31
- #### Returns
32
-
33
- `any`
34
-
35
- ***
36
-
37
- ### pauseFn()?
38
-
39
- > `optional` **pauseFn**: () => `void`
40
-
41
- Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:23](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/async-semaphore.ts#L23)
42
-
43
- #### Returns
44
-
45
- `void`
46
-
47
- ***
48
-
49
- ### resumeFn()?
50
-
51
- > `optional` **resumeFn**: () => `void`
52
-
53
- Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:24](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/async-semaphore.ts#L24)
54
-
55
- #### Returns
56
-
57
- `void`
package/docs/interfaces/BinarySemaphoreReleaseOptions.md DELETED
@@ -1,25 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md)
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / BinarySemaphoreReleaseOptions
6
-
7
- # Interface: BinarySemaphoreReleaseOptions
8
-
9
- Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:33](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/async-semaphore.ts#L33)
10
-
11
- ## Extended by
12
-
13
- - [`BinarySemaphoreReleaserFunc`](BinarySemaphoreReleaserFunc.md)
14
-
15
- ## Indexable
16
-
17
- \[`n`: `string`\]: `any`
18
-
19
- ## Properties
20
-
21
- ### token?
22
-
23
- > `optional` **token**: `any`
24
-
25
- Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:34](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/async-semaphore.ts#L34)
package/docs/interfaces/BinarySemaphoreReleaserFunc.md DELETED
@@ -1,37 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md)
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / BinarySemaphoreReleaserFunc
6
-
7
- # Interface: BinarySemaphoreReleaserFunc()
8
-
9
- Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:38](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/async-semaphore.ts#L38)
10
-
11
- ## Extends
12
-
13
- - [`BinarySemaphoreReleaseOptions`](BinarySemaphoreReleaseOptions.md)
14
-
15
- > **BinarySemaphoreReleaserFunc**(): `void`
16
-
17
- Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:39](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/async-semaphore.ts#L39)
18
-
19
- ## Returns
20
-
21
- `void`
22
-
23
- ## Indexable
24
-
25
- \[`n`: `string`\]: `any`
26
-
27
- ## Properties
28
-
29
- ### token?
30
-
31
- > `optional` **token**: `any`
32
-
33
- Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:34](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/async-semaphore.ts#L34)
34
-
35
- #### Inherited from
36
-
37
- [`BinarySemaphoreReleaseOptions`](BinarySemaphoreReleaseOptions.md).[`token`](BinarySemaphoreReleaseOptions.md#token)
package/docs/interfaces/CancelableAbilityOptions.md DELETED
@@ -1,113 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md)
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / CancelableAbilityOptions
6
-
7
- # Interface: CancelableAbilityOptions
8
-
9
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:29](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/cancelable-ability.ts#L29)
10
-
11
- ## Extends
12
-
13
- - `AbilityOptions`
14
-
15
- ## Indexable
16
-
17
- \[`name`: `string`\]: `any`
18
-
19
- ## Properties
20
-
21
- ### asyncFeatures?
22
-
23
- > `optional` **asyncFeatures**: [`AsyncFeatures`](../enumerations/AsyncFeatures.md)
24
-
25
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:30](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/cancelable-ability.ts#L30)
26
-
27
- ***
28
-
29
- ### classMethods?
30
-
31
- > `optional` **classMethods**: `Record`\<`string`, `Function`\>
32
-
33
- Defined in: node\_modules/.pnpm/custom-ability@2.0.1/node\_modules/custom-ability/lib/custom-ability.d.ts:13
34
-
35
- #### Inherited from
36
-
37
- `AbilityOptions.classMethods`
38
-
39
- ***
40
-
41
- ### exclude?
42
-
43
- > `optional` **exclude**: `string` \| `string`[]
44
-
45
- Defined in: node\_modules/.pnpm/custom-ability@2.0.1/node\_modules/custom-ability/lib/custom-ability.d.ts:11
46
-
47
- #### Inherited from
48
-
49
- `AbilityOptions.exclude`
50
-
51
- ***
52
-
53
- ### id?
54
-
55
- > `optional` **id**: `string`
56
-
57
- Defined in: node\_modules/.pnpm/custom-ability@2.0.1/node\_modules/custom-ability/lib/custom-ability.d.ts:8
58
-
59
- #### Inherited from
60
-
61
- `AbilityOptions.id`
62
-
63
- ***
64
-
65
- ### include?
66
-
67
- > `optional` **include**: `string` \| `string`[]
68
-
69
- Defined in: node\_modules/.pnpm/custom-ability@2.0.1/node\_modules/custom-ability/lib/custom-ability.d.ts:10
70
-
71
- #### Inherited from
72
-
73
- `AbilityOptions.include`
74
-
75
- ***
76
-
77
- ### isReadyFn?
78
-
79
- > `optional` **isReadyFn**: [`SemaphoreIsReadyFuncType`](../type-aliases/SemaphoreIsReadyFuncType.md)
80
-
81
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:32](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/cancelable-ability.ts#L32)
82
-
83
- ***
84
-
85
- ### maxTaskConcurrency?
86
-
87
- > `optional` **maxTaskConcurrency**: `number`
88
-
89
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:31](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/cancelable-ability.ts#L31)
90
-
91
- ***
92
-
93
- ### methods?
94
-
95
- > `optional` **methods**: `Record`\<`string`, `Function`\>
96
-
97
- Defined in: node\_modules/.pnpm/custom-ability@2.0.1/node\_modules/custom-ability/lib/custom-ability.d.ts:12
98
-
99
- #### Inherited from
100
-
101
- `AbilityOptions.methods`
102
-
103
- ***
104
-
105
- ### mode?
106
-
107
- > `optional` **mode**: `number`
108
-
109
- Defined in: node\_modules/.pnpm/custom-ability@2.0.1/node\_modules/custom-ability/lib/custom-ability.d.ts:9
110
-
111
- #### Inherited from
112
-
113
- `AbilityOptions.mode`