@isdk/ai-tool 0.8.0 → 0.8.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (287) hide show
  1. package/docs/api/classes/BinarySemaphore.md +25 -25
  2. package/docs/api/classes/CancelableAbility.md +25 -25
  3. package/docs/api/classes/ClientToolTransport.md +12 -12
  4. package/docs/api/classes/ClientTools.md +61 -61
  5. package/docs/api/classes/EventClient.md +88 -88
  6. package/docs/api/classes/EventServer.md +83 -83
  7. package/docs/api/classes/EventToolFunc.md +52 -52
  8. package/docs/api/classes/FewShotPromptTemplate.md +11 -11
  9. package/docs/api/classes/HttpClientToolTransport.md +13 -13
  10. package/docs/api/classes/HttpServerToolTransport.md +15 -15
  11. package/docs/api/classes/IntSet.md +12 -12
  12. package/docs/api/classes/PromptExampleSelector.md +9 -9
  13. package/docs/api/classes/ReadableStreamError.md +2 -2
  14. package/docs/api/classes/ResClientTools.md +68 -68
  15. package/docs/api/classes/ResServerTools.md +69 -69
  16. package/docs/api/classes/RpcMethodsClientTool.md +63 -63
  17. package/docs/api/classes/RpcMethodsServerTool.md +64 -64
  18. package/docs/api/classes/SSEChannel.md +19 -19
  19. package/docs/api/classes/Semaphore.md +26 -26
  20. package/docs/api/classes/ServerToolTransport.md +13 -13
  21. package/docs/api/classes/ServerTools.md +57 -57
  22. package/docs/api/classes/SignalGate.md +9 -9
  23. package/docs/api/classes/SseClientPubSubTransport.md +4 -4
  24. package/docs/api/classes/SseServerPubSubTransport.md +10 -10
  25. package/docs/api/classes/TaskAbortController.md +8 -8
  26. package/docs/api/classes/ToolFunc.md +50 -50
  27. package/docs/api/classes/ToolTransport.md +7 -7
  28. package/docs/api/classes/YamlTypeBaseObject.md +2 -2
  29. package/docs/api/enumerations/AsyncFeatureBits.md +4 -4
  30. package/docs/api/enumerations/AsyncFeatures.md +4 -4
  31. package/docs/api/enumerations/HashAlgorithm.md +12 -12
  32. package/docs/api/functions/AIArgProcessor.md +1 -1
  33. package/docs/api/functions/AIStream.md +1 -1
  34. package/docs/api/functions/ChoiceArgProcessor.md +1 -1
  35. package/docs/api/functions/DefaultDateFormat.md +1 -1
  36. package/docs/api/functions/ObjectArgsToArgsInfo.md +1 -1
  37. package/docs/api/functions/RateLimit.md +1 -1
  38. package/docs/api/functions/TemplateArgProcessor.md +1 -1
  39. package/docs/api/functions/assignDirs.md +1 -1
  40. package/docs/api/functions/beforeShutdown.md +1 -1
  41. package/docs/api/functions/calcPerplexity.md +1 -1
  42. package/docs/api/functions/calcPerplexitySimple.md +1 -1
  43. package/docs/api/functions/completeSentences.md +1 -1
  44. package/docs/api/functions/concatText.md +1 -1
  45. package/docs/api/functions/countLLMTokens.md +1 -1
  46. package/docs/api/functions/countRegexMatches.md +1 -1
  47. package/docs/api/functions/createCallbacksTransformer.md +1 -1
  48. package/docs/api/functions/createEmptyReadableStream.md +1 -1
  49. package/docs/api/functions/createEndWithRepetitionDetector.md +1 -1
  50. package/docs/api/functions/createEventStreamTransformer.md +1 -1
  51. package/docs/api/functions/createLRUCache.md +1 -1
  52. package/docs/api/functions/createYamlObjectTag.md +1 -1
  53. package/docs/api/functions/dateToText.md +1 -1
  54. package/docs/api/functions/decodeCharset.md +1 -1
  55. package/docs/api/functions/defaultsWithConcat.md +1 -1
  56. package/docs/api/functions/detectCharset.md +1 -1
  57. package/docs/api/functions/encodeLLMTokens.md +1 -1
  58. package/docs/api/functions/ensureQuoted.md +1 -1
  59. package/docs/api/functions/expandConfig.md +1 -1
  60. package/docs/api/functions/expandPath.md +1 -1
  61. package/docs/api/functions/expandPathInObject.md +1 -1
  62. package/docs/api/functions/expandPaths.md +1 -1
  63. package/docs/api/functions/fileIsExists.md +1 -1
  64. package/docs/api/functions/filterValidFnScope.md +1 -1
  65. package/docs/api/functions/findIndexNonEmptyFrom.md +1 -1
  66. package/docs/api/functions/findPort.md +1 -1
  67. package/docs/api/functions/formatTextWithSpace.md +1 -1
  68. package/docs/api/functions/funcGetMeta.md +1 -1
  69. package/docs/api/functions/funcWithMeta.md +1 -1
  70. package/docs/api/functions/genUrlParamsStr.md +1 -1
  71. package/docs/api/functions/getAllEnumKeys.md +1 -1
  72. package/docs/api/functions/getConfigFileNames.md +1 -1
  73. package/docs/api/functions/getConfigs.md +1 -1
  74. package/docs/api/functions/getFileMetaInfo.md +1 -1
  75. package/docs/api/functions/getHashAlgoBySize.md +1 -1
  76. package/docs/api/functions/getKeysPath.md +1 -1
  77. package/docs/api/functions/getLLMTokenizer.md +1 -1
  78. package/docs/api/functions/getPackageDir.md +1 -1
  79. package/docs/api/functions/getRealFilepath.md +1 -1
  80. package/docs/api/functions/getResponseErrorReadableStream.md +1 -1
  81. package/docs/api/functions/getXDGConfigs.md +1 -1
  82. package/docs/api/functions/hasDirectoryIn.md +1 -1
  83. package/docs/api/functions/hash.md +1 -1
  84. package/docs/api/functions/hashFile.md +1 -1
  85. package/docs/api/functions/hashObject.md +1 -1
  86. package/docs/api/functions/hashStream.md +1 -1
  87. package/docs/api/functions/initShutdown.md +1 -1
  88. package/docs/api/functions/isLangUsingSpaces.md +1 -1
  89. package/docs/api/functions/isListItemString.md +1 -1
  90. package/docs/api/functions/isModelNameMatched.md +1 -1
  91. package/docs/api/functions/isPunctuationChar.md +1 -1
  92. package/docs/api/functions/isQuoted.md +1 -1
  93. package/docs/api/functions/isRegExp.md +1 -1
  94. package/docs/api/functions/isSameString.md +1 -1
  95. package/docs/api/functions/isSectionString.md +1 -1
  96. package/docs/api/functions/isSentenceEnding.md +1 -1
  97. package/docs/api/functions/isSepLineString.md +1 -1
  98. package/docs/api/functions/isStrWrapped.md +1 -1
  99. package/docs/api/functions/isSubdirectory.md +1 -1
  100. package/docs/api/functions/isTitleString.md +1 -1
  101. package/docs/api/functions/isWebStream.md +1 -1
  102. package/docs/api/functions/joinSplitWords.md +1 -1
  103. package/docs/api/functions/jsonFilterToWhere.md +1 -1
  104. package/docs/api/functions/jsonToMarkdownStr.md +1 -1
  105. package/docs/api/functions/loadAIConfig.md +1 -1
  106. package/docs/api/functions/loadConfig.md +1 -1
  107. package/docs/api/functions/loadConfigFile.md +1 -1
  108. package/docs/api/functions/loadFileFromPaths.md +1 -1
  109. package/docs/api/functions/loadTextFromPaths.md +1 -1
  110. package/docs/api/functions/lrucache.md +1 -1
  111. package/docs/api/functions/matchUrlProtocol.md +1 -1
  112. package/docs/api/functions/memoize.md +1 -1
  113. package/docs/api/functions/mergeArray.md +1 -1
  114. package/docs/api/functions/messagesToText.md +1 -1
  115. package/docs/api/functions/normalizePath.md +1 -1
  116. package/docs/api/functions/paramsSizeToScaleStr.md +1 -1
  117. package/docs/api/functions/parseCommand.md +1 -1
  118. package/docs/api/functions/parseJsJson.md +1 -1
  119. package/docs/api/functions/parseJsJsonSimpleSync.md +1 -1
  120. package/docs/api/functions/parseObjectArgInfo.md +1 -1
  121. package/docs/api/functions/parseObjectArgumentInfos.md +1 -1
  122. package/docs/api/functions/parseObjectArguments.md +1 -1
  123. package/docs/api/functions/parseObjectArgumentsAsArgInfos.md +1 -1
  124. package/docs/api/functions/pruneSubdirectories.md +1 -1
  125. package/docs/api/functions/pruneSubdirectoriesInPlace.md +1 -1
  126. package/docs/api/functions/quoteStr.md +1 -1
  127. package/docs/api/functions/readFilenamesRecursiveSync.md +1 -1
  128. package/docs/api/functions/readTextFileChunks.md +1 -1
  129. package/docs/api/functions/readTextFileChunksEx.md +1 -1
  130. package/docs/api/functions/readableFromAsyncIterable.md +1 -1
  131. package/docs/api/functions/registerCoreTools.md +1 -1
  132. package/docs/api/functions/removeMarkdownBold.md +1 -1
  133. package/docs/api/functions/removeMarkdownBoldAndItalic.md +1 -1
  134. package/docs/api/functions/removeMarkdownItalic.md +1 -1
  135. package/docs/api/functions/replaceWithPlaceholder.md +1 -1
  136. package/docs/api/functions/restoreFromPlacehoders.md +1 -1
  137. package/docs/api/functions/saveConfigFile.md +1 -1
  138. package/docs/api/functions/scaleStrToParamsSize.md +1 -1
  139. package/docs/api/functions/shutdown.md +1 -1
  140. package/docs/api/functions/simplifyObjectArguments.md +1 -1
  141. package/docs/api/functions/sleep.md +1 -1
  142. package/docs/api/functions/sortedValues.md +1 -1
  143. package/docs/api/functions/splitChunks.md +1 -1
  144. package/docs/api/functions/splitParagraph.md +1 -1
  145. package/docs/api/functions/splitSentence.md +1 -1
  146. package/docs/api/functions/splitWords.md +1 -1
  147. package/docs/api/functions/stripConsoleColor.md +1 -1
  148. package/docs/api/functions/textToDate.md +1 -1
  149. package/docs/api/functions/toDateTime.md +1 -1
  150. package/docs/api/functions/trimStartOfStreamHelper.md +1 -1
  151. package/docs/api/functions/truncTo.md +1 -1
  152. package/docs/api/functions/truncateByToken.md +1 -1
  153. package/docs/api/functions/truncateToTokenLimit.md +1 -1
  154. package/docs/api/functions/truncateToTokenLimitEx.md +1 -1
  155. package/docs/api/functions/uuid.md +1 -1
  156. package/docs/api/functions/xxhash.md +1 -1
  157. package/docs/api/functions/xxhash32.md +1 -1
  158. package/docs/api/functions/xxhash64.md +1 -1
  159. package/docs/api/functions/xxhashAsStr.md +1 -1
  160. package/docs/api/functions/yieldExec.md +1 -1
  161. package/docs/api/interfaces/AIChatAssistantMessageParam.md +12 -12
  162. package/docs/api/interfaces/AIChatContentPartImage.md +3 -3
  163. package/docs/api/interfaces/AIChatContentPartText.md +3 -3
  164. package/docs/api/interfaces/AIChatMessageParamBase.md +7 -7
  165. package/docs/api/interfaces/AIChatMessageToolCall.md +4 -4
  166. package/docs/api/interfaces/AIChatSystemMessageParam.md +9 -9
  167. package/docs/api/interfaces/AIChatToolChoiceFuncObject.md +3 -3
  168. package/docs/api/interfaces/AIChatToolChoiceObject.md +2 -2
  169. package/docs/api/interfaces/AIChatToolFunc.md +5 -5
  170. package/docs/api/interfaces/AIChatToolFuncParam.md +3 -3
  171. package/docs/api/interfaces/AIChatToolMessageParam.md +10 -10
  172. package/docs/api/interfaces/AIChatToolParam.md +2 -2
  173. package/docs/api/interfaces/AIChatToolTypeObject.md +2 -2
  174. package/docs/api/interfaces/AIChatUserMessageParam.md +13 -13
  175. package/docs/api/interfaces/AIChoiceConfig.md +8 -8
  176. package/docs/api/interfaces/AIResult.md +6 -6
  177. package/docs/api/interfaces/AIStreamParser.md +2 -2
  178. package/docs/api/interfaces/AIStreamParserOptions.md +2 -2
  179. package/docs/api/interfaces/BaseFunc.md +15 -15
  180. package/docs/api/interfaces/BaseFuncItem.md +14 -14
  181. package/docs/api/interfaces/BinarySemaphoreAcquireOptions.md +2 -2
  182. package/docs/api/interfaces/BinarySemaphoreOptions.md +5 -5
  183. package/docs/api/interfaces/BinarySemaphoreReleaseOptions.md +2 -2
  184. package/docs/api/interfaces/BinarySemaphoreReleaserFunc.md +3 -3
  185. package/docs/api/interfaces/CancelableAbilityOptions.md +4 -4
  186. package/docs/api/interfaces/ClientFuncItem.md +17 -17
  187. package/docs/api/interfaces/EventClientFuncParams.md +5 -5
  188. package/docs/api/interfaces/EventServerFuncParams.md +7 -7
  189. package/docs/api/interfaces/FewShotPromptTemplateOptions.md +6 -6
  190. package/docs/api/interfaces/FuncItem.md +15 -15
  191. package/docs/api/interfaces/FuncParam.md +5 -5
  192. package/docs/api/interfaces/FuncParams.md +1 -1
  193. package/docs/api/interfaces/Funcs.md +1 -1
  194. package/docs/api/interfaces/HashAlgoParams.md +4 -4
  195. package/docs/api/interfaces/IClientToolTransport.md +7 -7
  196. package/docs/api/interfaces/IFileMetaInfo.md +8 -8
  197. package/docs/api/interfaces/IPubSubClientTransport.md +4 -4
  198. package/docs/api/interfaces/IPubSubServerTransport.md +11 -11
  199. package/docs/api/interfaces/IReadTextFileChunksOptions.md +11 -11
  200. package/docs/api/interfaces/IServerToolTransport.md +8 -8
  201. package/docs/api/interfaces/IToolTransport.md +5 -5
  202. package/docs/api/interfaces/ITruncateToTokenLimitOptions.md +10 -10
  203. package/docs/api/interfaces/JsonFilter.md +1 -1
  204. package/docs/api/interfaces/ParseObjectArgumentOptions.md +11 -11
  205. package/docs/api/interfaces/ProbabilityItem.md +4 -4
  206. package/docs/api/interfaces/PromptExampleSelectorOptions.md +3 -3
  207. package/docs/api/interfaces/PubSubClientStream.md +10 -10
  208. package/docs/api/interfaces/PubSubServerSession.md +7 -7
  209. package/docs/api/interfaces/RemoteFuncItem.md +17 -17
  210. package/docs/api/interfaces/ReplacePlacehoderOptions.md +5 -5
  211. package/docs/api/interfaces/ResClientFuncParams.md +3 -3
  212. package/docs/api/interfaces/ResServerFuncParams.md +6 -6
  213. package/docs/api/interfaces/RpcMethodsClientFuncParams.md +2 -2
  214. package/docs/api/interfaces/RpcMethodsServerFuncParams.md +4 -4
  215. package/docs/api/interfaces/SectionStringOptions.md +3 -3
  216. package/docs/api/interfaces/SemaphoreOptions.md +7 -7
  217. package/docs/api/interfaces/SemaphoreTaskItem.md +5 -5
  218. package/docs/api/interfaces/ServerFuncItem.md +18 -18
  219. package/docs/api/interfaces/ServerFuncParams.md +3 -3
  220. package/docs/api/interfaces/SplitSentenceOptions.md +5 -5
  221. package/docs/api/interfaces/StreamCallbacksAndOptions.md +5 -5
  222. package/docs/api/interfaces/TaskAbortControllers.md +1 -1
  223. package/docs/api/interfaces/TaskPromise.md +2 -2
  224. package/docs/api/interfaces/ToolFuncPackage.md +4 -4
  225. package/docs/api/type-aliases/AIChatContentPart.md +1 -1
  226. package/docs/api/type-aliases/AIChatMessageParam.md +1 -1
  227. package/docs/api/type-aliases/AIChatRole.md +1 -1
  228. package/docs/api/type-aliases/AIChatToolChoiceParam.md +1 -1
  229. package/docs/api/type-aliases/AIMessageType.md +1 -1
  230. package/docs/api/type-aliases/AIModelNameRule.md +1 -1
  231. package/docs/api/type-aliases/AIModelNameRuleFn.md +1 -1
  232. package/docs/api/type-aliases/AIModelNameRules.md +1 -1
  233. package/docs/api/type-aliases/AITextGenerationFinishReason.md +1 -1
  234. package/docs/api/type-aliases/ActionName.md +1 -1
  235. package/docs/api/type-aliases/ArrayMergeWay.md +1 -1
  236. package/docs/api/type-aliases/AsyncTaskId.md +1 -1
  237. package/docs/api/type-aliases/BeforeShutdownListener.md +1 -1
  238. package/docs/api/type-aliases/EventErrorListenerFn.md +1 -1
  239. package/docs/api/type-aliases/EventListenerFn.md +1 -1
  240. package/docs/api/type-aliases/FuncParamType.md +1 -1
  241. package/docs/api/type-aliases/PromptExamples.md +1 -1
  242. package/docs/api/type-aliases/PubSubClientId.md +1 -1
  243. package/docs/api/type-aliases/PubSubCtx.md +6 -6
  244. package/docs/api/type-aliases/RpcMethodHandler.md +1 -1
  245. package/docs/api/type-aliases/SSEClient.md +5 -5
  246. package/docs/api/type-aliases/SemaphoreIsReadyFuncType.md +1 -1
  247. package/docs/api/type-aliases/TFunc.md +1 -1
  248. package/docs/api/type-aliases/UUIDVersions.md +1 -1
  249. package/docs/api/variables/AIChatRoles.md +1 -1
  250. package/docs/api/variables/AIMessageTypes.md +1 -1
  251. package/docs/api/variables/AITextGenerationFinishReasons.md +1 -1
  252. package/docs/api/variables/ActionNames.md +1 -1
  253. package/docs/api/variables/ArrayMergeWay.md +1 -1
  254. package/docs/api/variables/ArrayMergeWaySymbol.md +1 -1
  255. package/docs/api/variables/ClientEventPrefix.md +1 -1
  256. package/docs/api/variables/ClientToolFuncSchema.md +1 -1
  257. package/docs/api/variables/DEFAULT_CONFIG_NAME.md +1 -1
  258. package/docs/api/variables/DefaultAsyncSemaphoreCapacity.md +1 -1
  259. package/docs/api/variables/EventBusName.md +1 -1
  260. package/docs/api/variables/EventName.md +1 -1
  261. package/docs/api/variables/FuncMetaSymbol.md +1 -1
  262. package/docs/api/variables/LLM_TOKENIZER_NAMES.md +1 -1
  263. package/docs/api/variables/LLM_TOKENIZER_NAMES_MAP.md +1 -1
  264. package/docs/api/variables/PASSING_SCORE.md +1 -1
  265. package/docs/api/variables/RStreamErrCode.md +1 -1
  266. package/docs/api/variables/RemoteToolFuncSchema.md +1 -1
  267. package/docs/api/variables/ResponseRStreamErrCode.md +1 -1
  268. package/docs/api/variables/RpcMethodsClientToolSchema.md +1 -1
  269. package/docs/api/variables/RpcMethodsServerToolSchema.md +1 -1
  270. package/docs/api/variables/SHUTDOWN_SIGNALS.md +1 -1
  271. package/docs/api/variables/SSEChannelAlreadyClosedErrCode.md +1 -1
  272. package/docs/api/variables/SecondaryCache.md +1 -1
  273. package/docs/api/variables/ServerToolFuncSchema.md +1 -1
  274. package/docs/api/variables/StrangeHumanName.md +1 -1
  275. package/docs/api/variables/ToolAsyncCancelableBit.md +1 -1
  276. package/docs/api/variables/ToolAsyncMultiTaskBit.md +1 -1
  277. package/docs/api/variables/ToolAsyncPriorityBit.md +1 -1
  278. package/docs/api/variables/ToolFuncSchema.md +1 -1
  279. package/docs/api/variables/backendEventable.md +1 -1
  280. package/docs/api/variables/base32768.md +1 -1
  281. package/docs/api/variables/event.md +1 -1
  282. package/docs/api/variables/eventClient.md +1 -1
  283. package/docs/api/variables/eventServer.md +1 -1
  284. package/docs/api/variables/lrucache.md +1 -1
  285. package/docs/api/variables/makeToolFuncCancelable.md +1 -1
  286. package/docs/api/variables/wait.md +1 -1
  287. package/package.json +3 -3
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: EventClient
8
8
 
9
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:14](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/funcs/event-client.ts#L14)
9
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:14](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/funcs/event-client.ts#L14)
10
10
 
11
11
  Represents a client-side proxy for a remote tool function.
12
12
 
@@ -31,7 +31,7 @@ These tools are typically created dynamically by loading definitions from a serv
31
31
 
32
32
  > **new EventClient**(`name`, `options?`): `EventClient`
33
33
 
34
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:571](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L571)
34
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:571](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L571)
35
35
 
36
36
  Initializes a new `ToolFunc` instance.
37
37
 
@@ -63,7 +63,7 @@ Configuration options if not provided in the first argument.
63
63
 
64
64
  > **\_forwardEvents**: `Set`\<`string`\>
65
65
 
66
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:33](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/funcs/event-client.ts#L33)
66
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:33](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/funcs/event-client.ts#L33)
67
67
 
68
68
  ***
69
69
 
@@ -71,7 +71,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:33](https
71
71
 
72
72
  > **\_sseListeners**: `Record`\<`string`, (`data`, `ctx?`) => `void`\> = `{}`
73
73
 
74
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:32](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/funcs/event-client.ts#L32)
74
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:32](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/funcs/event-client.ts#L32)
75
75
 
76
76
  ***
77
77
 
@@ -79,7 +79,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:32](https
79
79
 
80
80
  > **\_stream**: `undefined` \| [`PubSubClientStream`](../interfaces/PubSubClientStream.md)
81
81
 
82
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:29](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/funcs/event-client.ts#L29)
82
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:29](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/funcs/event-client.ts#L29)
83
83
 
84
84
  ***
85
85
 
@@ -87,7 +87,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:29](https
87
87
 
88
88
  > **\_streamEvents**: `undefined` \| `string`[]
89
89
 
90
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:30](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/funcs/event-client.ts#L30)
90
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:30](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/funcs/event-client.ts#L30)
91
91
 
92
92
  ***
93
93
 
@@ -107,7 +107,7 @@ Defined in: [property-manager.js/src/advance.d.ts:5](https://github.com/snowyu/p
107
107
 
108
108
  > `optional` **action**: `"get"` \| `"post"` \| `"put"` \| `"delete"` \| `"patch"` \| `"list"` \| `"res"`
109
109
 
110
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:95](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/consts.ts#L95)
110
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:95](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/consts.ts#L95)
111
111
 
112
112
  The action to be used for the remote call. This typically represents an RPC method name.
113
113
  Only for RESTful HTTP transports, it might be mapped to a standard HTTP method (e.g., GET, POST)
@@ -122,7 +122,7 @@ Only for RESTful HTTP transports, it might be mapped to a standard HTTP method (
122
122
 
123
123
  > `optional` **alias**: `string` \| `string`[]
124
124
 
125
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:130](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L130)
125
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:130](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L130)
126
126
 
127
127
  Optional aliases for the function name.
128
128
 
@@ -136,7 +136,7 @@ Optional aliases for the function name.
136
136
 
137
137
  > `optional` **asyncFeatures**: `number`
138
138
 
139
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:144](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L144)
139
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:144](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L144)
140
140
 
141
141
  A bitmask representing asynchronous features supported by the function, built from `AsyncFeatureBits`.
142
142
  This allows the system to understand if a function supports capabilities like cancellation or multi-tasking.
@@ -202,7 +202,7 @@ The default options for export and assign
202
202
 
203
203
  > `optional` **depends**: `object`
204
204
 
205
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:167](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L167)
205
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:167](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L167)
206
206
 
207
207
  A map of dependencies this function has on other tool functions.
208
208
  Declaring dependencies ensures that they are automatically registered when this function is registered.
@@ -241,7 +241,7 @@ mainFunc.register();
241
241
 
242
242
  > **description**: `string` = `'subscribe server event'`
243
243
 
244
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:61](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/funcs/event-client.ts#L61)
244
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:61](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/funcs/event-client.ts#L61)
245
245
 
246
246
  A detailed description of what the function does.
247
247
 
@@ -255,7 +255,7 @@ A detailed description of what the function does.
255
255
 
256
256
  > **ebListener**: (`this`, ...`args`) => `Promise`\<`void`\>
257
257
 
258
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:101](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/funcs/event-client.ts#L101)
258
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:101](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/funcs/event-client.ts#L101)
259
259
 
260
260
  #### Parameters
261
261
 
@@ -277,7 +277,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:101](http
277
277
 
278
278
  > `optional` **fetchOptions**: `any`
279
279
 
280
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:100](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/consts.ts#L100)
280
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:100](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/consts.ts#L100)
281
281
 
282
282
  Addtional options to be passed to the underlying `fetch` call in a transport.
283
283
 
@@ -291,7 +291,7 @@ Addtional options to be passed to the underlying `fetch` call in a transport.
291
291
 
292
292
  > `optional` **isApi**: `boolean`
293
293
 
294
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:119](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L119)
294
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:119](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L119)
295
295
 
296
296
  If true, indicates that this function should be treated as a server-side API.
297
297
 
@@ -305,7 +305,7 @@ If true, indicates that this function should be treated as a server-side API.
305
305
 
306
306
  > `optional` **name**: `string`
307
307
 
308
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:76](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L76)
308
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:76](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L76)
309
309
 
310
310
  The unique name of the function.
311
311
 
@@ -333,7 +333,7 @@ the property with the default prefix '$' will not be exported.
333
333
 
334
334
  > `optional` **params**: [`FuncParams`](../interfaces/FuncParams.md) \| [`FuncParam`](../interfaces/FuncParam.md)[]
335
335
 
336
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:81](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L81)
336
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:81](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L81)
337
337
 
338
338
  Parameter definitions, which can be an object mapping names to definitions or an array for positional parameters.
339
339
 
@@ -347,7 +347,7 @@ Parameter definitions, which can be an object mapping names to definitions or an
347
347
 
348
348
  > `optional` **result**: `string` \| `Record`\<`string`, `any`\>
349
349
 
350
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:86](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L86)
350
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:86](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L86)
351
351
 
352
352
  The expected return type of the function, described as a string or a JSON schema object.
353
353
 
@@ -361,7 +361,7 @@ The expected return type of the function, described as a string or a JSON schema
361
361
 
362
362
  > `optional` **scope**: `any`
363
363
 
364
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:91](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L91)
364
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:91](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L91)
365
365
 
366
366
  The execution scope or context (`this`) for the function.
367
367
 
@@ -375,7 +375,7 @@ The execution scope or context (`this`) for the function.
375
375
 
376
376
  > `optional` **setup**: (`this`, `options?`) => `void`
377
377
 
378
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:114](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L114)
378
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:114](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L114)
379
379
 
380
380
  A lifecycle hook called once during the `ToolFunc` instance's initialization.
381
381
  It allows for initial setup, state configuration, or property modification on the instance
@@ -421,7 +421,7 @@ console.log(myFunc.customState); // Outputs: 'configured'
421
421
 
422
422
  > `optional` **stream**: `boolean`
423
423
 
424
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:125](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L125)
424
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:125](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L125)
425
425
 
426
426
  If true, indicates that the function has the *capability* to stream its output.
427
427
  Whether a specific call is streamed is determined by a `stream` property in the runtime parameters.
@@ -436,7 +436,7 @@ Whether a specific call is streamed is determined by a `stream` property in the
436
436
 
437
437
  > `optional` **tags**: `string` \| `string`[]
438
438
 
439
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:96](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L96)
439
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:96](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L96)
440
440
 
441
441
  Tags for grouping or filtering functions.
442
442
 
@@ -450,7 +450,7 @@ Tags for grouping or filtering functions.
450
450
 
451
451
  > `optional` **title**: `string`
452
452
 
453
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:177](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L177)
453
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:177](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L177)
454
454
 
455
455
  A concise, human-readable title for the function, often used in UI or by AI.
456
456
 
@@ -464,7 +464,7 @@ A concise, human-readable title for the function, often used in UI or by AI.
464
464
 
465
465
  > `static` **\_pubSubTransport**: `undefined` \| [`IPubSubClientTransport`](../interfaces/IPubSubClientTransport.md)
466
466
 
467
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:15](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/funcs/event-client.ts#L15)
467
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:15](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/funcs/event-client.ts#L15)
468
468
 
469
469
  ***
470
470
 
@@ -472,7 +472,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:15](https
472
472
 
473
473
  > `static` `optional` **action**: `string`
474
474
 
475
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:33](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/client-tools.ts#L33)
475
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:33](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/client-tools.ts#L33)
476
476
 
477
477
  #### Inherited from
478
478
 
@@ -484,7 +484,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:33](https://git
484
484
 
485
485
  > `static` **aliases**: `object` = `{}`
486
486
 
487
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:305](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L305)
487
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:305](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L305)
488
488
 
489
489
  A static map of aliases to their corresponding function names.
490
490
 
@@ -502,7 +502,7 @@ A static map of aliases to their corresponding function names.
502
502
 
503
503
  > `static` **dataPath**: `string`
504
504
 
505
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:312](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L312)
505
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:312](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L312)
506
506
 
507
507
  A conventional property to designate a file path for saving the registered `ToolFunc` data.
508
508
  Note: The `ToolFunc` class itself does not implement persistence logic. It is up to the
@@ -518,7 +518,7 @@ developer to use this path to save and load the `ToolFunc.items` registry if nee
518
518
 
519
519
  > `static` **items**: [`Funcs`](../interfaces/Funcs.md) = `{}`
520
520
 
521
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:300](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L300)
521
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:300](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L300)
522
522
 
523
523
  A static registry of all `ToolFunc` instances, indexed by name.
524
524
 
@@ -534,7 +534,7 @@ A static registry of all `ToolFunc` instances, indexed by name.
534
534
 
535
535
  > **get** **active**(): `boolean`
536
536
 
537
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:47](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/funcs/event-client.ts#L47)
537
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:47](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/funcs/event-client.ts#L47)
538
538
 
539
539
  ##### Returns
540
540
 
@@ -548,7 +548,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:47](https
548
548
 
549
549
  > **get** **apiRoot**(): `string`
550
550
 
551
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:110](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/client-tools.ts#L110)
551
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:110](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/client-tools.ts#L110)
552
552
 
553
553
  Gets the root URL for API endpoints from the configured transport.
554
554
  This is used as the base for constructing request URLs.
@@ -575,7 +575,7 @@ Use `transport` instead.
575
575
 
576
576
  > **get** **clientId**(): `undefined` \| `string`
577
577
 
578
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:35](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/funcs/event-client.ts#L35)
578
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:35](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/funcs/event-client.ts#L35)
579
579
 
580
580
  ##### Returns
581
581
 
@@ -589,7 +589,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:35](https
589
589
 
590
590
  > **get** `static` **apiRoot**(): `string`
591
591
 
592
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:41](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/client-tools.ts#L41)
592
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:41](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/client-tools.ts#L41)
593
593
 
594
594
  Gets the root URL for API endpoints from the configured transport.
595
595
  This is used as the base for constructing request URLs.
@@ -610,7 +610,7 @@ This is used as the base for constructing request URLs.
610
610
 
611
611
  > **get** `static` **pubSubTransport**(): [`IPubSubClientTransport`](../interfaces/IPubSubClientTransport.md)
612
612
 
613
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:24](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/funcs/event-client.ts#L24)
613
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:24](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/funcs/event-client.ts#L24)
614
614
 
615
615
  ##### Returns
616
616
 
@@ -624,7 +624,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:24](https
624
624
 
625
625
  > **get** `static` **transport**(): [`IClientToolTransport`](../interfaces/IClientToolTransport.md)
626
626
 
627
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:61](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/client-tools.ts#L61)
627
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:61](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/client-tools.ts#L61)
628
628
 
629
629
  ##### Returns
630
630
 
@@ -640,7 +640,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:61](https://git
640
640
 
641
641
  > **\_func**(`action`, `options`, `fetchOptions?`): `Promise`\<`any`\>
642
642
 
643
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-client-tool.ts:19](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/rpc-methods-client-tool.ts#L19)
643
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-client-tool.ts:19](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/rpc-methods-client-tool.ts#L19)
644
644
 
645
645
  #### Parameters
646
646
 
@@ -670,7 +670,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-client-tool.ts:19](
670
670
 
671
671
  > **arr2ObjParams**(`params`): `any`[]
672
672
 
673
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:629](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L629)
673
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:629](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L629)
674
674
 
675
675
  Converts an array of positional arguments into a named parameters object.
676
676
  This is used internally to support functions defined with named parameters.
@@ -731,7 +731,7 @@ this object
731
731
 
732
732
  > **assignMethods**(`methods`): `void`
733
733
 
734
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-client-tool.ts:32](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/rpc-methods-client-tool.ts#L32)
734
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-client-tool.ts:32](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/rpc-methods-client-tool.ts#L32)
735
735
 
736
736
  #### Parameters
737
737
 
@@ -945,7 +945,7 @@ the new dest object
945
945
 
946
946
  > **close**(): `void`
947
947
 
948
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:211](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/funcs/event-client.ts#L211)
948
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:211](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/funcs/event-client.ts#L211)
949
949
 
950
950
  #### Returns
951
951
 
@@ -983,7 +983,7 @@ the defined attributes of the object
983
983
 
984
984
  > `optional` **delete**(`__namedParameters`): `any`
985
985
 
986
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:13](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/res-client-tools.ts#L13)
986
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:13](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/res-client-tools.ts#L13)
987
987
 
988
988
  #### Parameters
989
989
 
@@ -1005,7 +1005,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:13](https:/
1005
1005
 
1006
1006
  > **esListener**(`evtType`, `data`, `ctx?`): `void`
1007
1007
 
1008
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:90](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/funcs/event-client.ts#L90)
1008
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:90](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/funcs/event-client.ts#L90)
1009
1009
 
1010
1010
  #### Parameters
1011
1011
 
@@ -1063,7 +1063,7 @@ the dest object.
1063
1063
 
1064
1064
  > **fetch**(`options`, `action`, ...`args`): `Promise`\<`any`\>
1065
1065
 
1066
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:18](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/res-client-tools.ts#L18)
1066
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:18](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/res-client-tools.ts#L18)
1067
1067
 
1068
1068
  #### Parameters
1069
1069
 
@@ -1093,7 +1093,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:18](https:/
1093
1093
 
1094
1094
  > **forwardEvent**(`events`): `void`
1095
1095
 
1096
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:172](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/funcs/event-client.ts#L172)
1096
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:172](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/funcs/event-client.ts#L172)
1097
1097
 
1098
1098
  forward local event(s) to server
1099
1099
 
@@ -1117,7 +1117,7 @@ Note: pls backendEventable(ClientTools or EventClient) first
1117
1117
 
1118
1118
  > **func**(`options`): `Promise`\<`any`\>
1119
1119
 
1120
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-client-tool.ts:24](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/rpc-methods-client-tool.ts#L24)
1120
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-client-tool.ts:24](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/rpc-methods-client-tool.ts#L24)
1121
1121
 
1122
1122
  The core implementation for a client-side tool. When a `ClientTools` instance
1123
1123
  is "run", this `func` method is executed. It delegates the call to the
@@ -1145,7 +1145,7 @@ The result from the remote tool.
1145
1145
 
1146
1146
  > `optional` **get**(`__namedParameters`): `any`
1147
1147
 
1148
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/res-client-tools.ts#L10)
1148
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/res-client-tools.ts#L10)
1149
1149
 
1150
1150
  #### Parameters
1151
1151
 
@@ -1167,7 +1167,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:10](https:/
1167
1167
 
1168
1168
  > **getEvtSource**(): `Promise`\<[`PubSubClientStream`](../interfaces/PubSubClientStream.md)\>
1169
1169
 
1170
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:39](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/funcs/event-client.ts#L39)
1170
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:39](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/funcs/event-client.ts#L39)
1171
1171
 
1172
1172
  #### Returns
1173
1173
 
@@ -1179,7 +1179,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:39](https
1179
1179
 
1180
1180
  > **getFunc**(`name?`): `any`
1181
1181
 
1182
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:720](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L720)
1182
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:720](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L720)
1183
1183
 
1184
1184
  Gets a bound function reference for execution with named parameters.
1185
1185
  If a name is provided, it retrieves a different function from the registry.
@@ -1209,7 +1209,7 @@ A function reference or `undefined` if not found.
1209
1209
 
1210
1210
  > **getFuncWithPos**(`name?`): `any`
1211
1211
 
1212
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:777](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L777)
1212
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:777](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L777)
1213
1213
 
1214
1214
  Gets a bound function reference suitable for positional argument execution.
1215
1215
  If a name is provided, it retrieves a different function from the registry.
@@ -1259,7 +1259,7 @@ the descriptors of properties object
1259
1259
 
1260
1260
  > **hasAsyncFeature**(`feature`): `boolean`
1261
1261
 
1262
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:787](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L787)
1262
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:787](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L787)
1263
1263
 
1264
1264
  Checks if the current function instance supports a specific async feature.
1265
1265
 
@@ -1313,7 +1313,7 @@ A property name.
1313
1313
 
1314
1314
  > **init**(`events`): `Promise`\<`any`\>
1315
1315
 
1316
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:204](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/funcs/event-client.ts#L204)
1316
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:204](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/funcs/event-client.ts#L204)
1317
1317
 
1318
1318
  #### Parameters
1319
1319
 
@@ -1331,7 +1331,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:204](http
1331
1331
 
1332
1332
  > **initEventStream**(`events?`): `Promise`\<[`PubSubClientStream`](../interfaces/PubSubClientStream.md)\>
1333
1333
 
1334
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:63](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/funcs/event-client.ts#L63)
1334
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:63](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/funcs/event-client.ts#L63)
1335
1335
 
1336
1336
  #### Parameters
1337
1337
 
@@ -1431,7 +1431,7 @@ The source object
1431
1431
 
1432
1432
  > **isStream**(`params`): `undefined` \| `boolean`
1433
1433
 
1434
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:805](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L805)
1434
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:805](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L805)
1435
1435
 
1436
1436
  Determines if a function call should produce a stream.
1437
1437
 
@@ -1465,7 +1465,7 @@ The runtime parameters passed to the function call.
1465
1465
 
1466
1466
  > `optional` **list**(`options?`): `any`
1467
1467
 
1468
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:14](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/res-client-tools.ts#L14)
1468
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:14](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/res-client-tools.ts#L14)
1469
1469
 
1470
1470
  #### Parameters
1471
1471
 
@@ -1519,7 +1519,7 @@ the dest object.
1519
1519
 
1520
1520
  > **obj2ArrParams**(`params?`): `any`[]
1521
1521
 
1522
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:648](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L648)
1522
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:648](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L648)
1523
1523
 
1524
1524
  Converts a named parameters object into an array of positional arguments.
1525
1525
  This is used for functions defined with positional parameters.
@@ -1548,7 +1548,7 @@ An array of positional arguments.
1548
1548
 
1549
1549
  > `optional` **post**(`options`): `any`
1550
1550
 
1551
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:11](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/res-client-tools.ts#L11)
1551
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:11](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/res-client-tools.ts#L11)
1552
1552
 
1553
1553
  #### Parameters
1554
1554
 
@@ -1596,7 +1596,7 @@ A property name.
1596
1596
 
1597
1597
  > `optional` **put**(`__namedParameters`): `any`
1598
1598
 
1599
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:12](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/res-client-tools.ts#L12)
1599
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:12](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/res-client-tools.ts#L12)
1600
1600
 
1601
1601
  #### Parameters
1602
1602
 
@@ -1618,7 +1618,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:12](https:/
1618
1618
 
1619
1619
  > **register**(): `boolean` \| [`ToolFunc`](ToolFunc.md)
1620
1620
 
1621
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:602](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L602)
1621
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:602](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L602)
1622
1622
 
1623
1623
  Registers the current `ToolFunc` instance into the static registry.
1624
1624
  Also registers any declared dependencies.
@@ -1639,7 +1639,7 @@ The instance itself upon successful registration, or `false` if it already exist
1639
1639
 
1640
1640
  > **run**(`params?`): `Promise`\<`any`\>
1641
1641
 
1642
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:686](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L686)
1642
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:686](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L686)
1643
1643
 
1644
1644
  Executes the function asynchronously with a named parameters object.
1645
1645
 
@@ -1667,7 +1667,7 @@ A promise that resolves with the function's result.
1667
1667
 
1668
1668
  > **runAs**(`name`, `params?`): `Promise`\<`any`\>
1669
1669
 
1670
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:697](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L697)
1670
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:697](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L697)
1671
1671
 
1672
1672
  Asynchronously executes another registered function by name.
1673
1673
  This method delegates to `runAsSync()` internally.
@@ -1702,7 +1702,7 @@ A promise that resolves with the result of the function execution.
1702
1702
 
1703
1703
  > **runAsSync**(`name`, `params?`): `any`
1704
1704
 
1705
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:708](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L708)
1705
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:708](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L708)
1706
1706
 
1707
1707
  Synchronously executes another registered function by name.
1708
1708
  This is a convenience method that forwards the call to the static `runSync()` method.
@@ -1737,7 +1737,7 @@ The result of the function execution.
1737
1737
 
1738
1738
  > **runSync**(`params?`): `any`
1739
1739
 
1740
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:667](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L667)
1740
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:667](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L667)
1741
1741
 
1742
1742
  Executes the function synchronously with a named parameters object.
1743
1743
 
@@ -1769,7 +1769,7 @@ Will throw an error if an array of parameters is passed to a function that expec
1769
1769
 
1770
1770
  > **runWithPos**(...`params`): `Promise`\<`any`\>
1771
1771
 
1772
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:755](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L755)
1772
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:755](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L755)
1773
1773
 
1774
1774
  Executes the function asynchronously using positional arguments.
1775
1775
  Delegates to `runWithPosSync()` internally.
@@ -1798,7 +1798,7 @@ A promise that resolves with the result of the function execution.
1798
1798
 
1799
1799
  > **runWithPosAs**(`name`, ...`params`): `Promise`\<`any`\>
1800
1800
 
1801
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:766](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L766)
1801
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:766](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L766)
1802
1802
 
1803
1803
  Asynchronously executes another function by name using positional arguments.
1804
1804
  Delegates to `runWithPosAsSync()` internally.
@@ -1833,7 +1833,7 @@ A promise that resolves with the result of the function execution.
1833
1833
 
1834
1834
  > **runWithPosAsSync**(`name`, ...`params`): `any`
1835
1835
 
1836
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:745](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L745)
1836
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:745](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L745)
1837
1837
 
1838
1838
  Synchronously executes another function by name using positional arguments.
1839
1839
  This is a convenience wrapper around the static `runWithPosSync()` method.
@@ -1868,7 +1868,7 @@ The result of the function execution.
1868
1868
 
1869
1869
  > **runWithPosSync**(...`params`): `any`
1870
1870
 
1871
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:731](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L731)
1871
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:731](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L731)
1872
1872
 
1873
1873
  Executes the function synchronously using positional arguments.
1874
1874
  If the function expects named parameters, it converts the arguments automatically.
@@ -1897,7 +1897,7 @@ The result of the function execution.
1897
1897
 
1898
1898
  > **setActive**(`v`): `Promise`\<`void`\>
1899
1899
 
1900
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:51](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/funcs/event-client.ts#L51)
1900
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:51](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/funcs/event-client.ts#L51)
1901
1901
 
1902
1902
  #### Parameters
1903
1903
 
@@ -1915,7 +1915,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:51](https
1915
1915
 
1916
1916
  > **subscribe**(`events`): `Promise`\<`any`\>
1917
1917
 
1918
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:126](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/funcs/event-client.ts#L126)
1918
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:126](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/funcs/event-client.ts#L126)
1919
1919
 
1920
1920
  subscribe server event
1921
1921
 
@@ -2013,7 +2013,7 @@ Returns a string representation of an object.
2013
2013
 
2014
2014
  > **unforwardEvent**(`events`): `void`
2015
2015
 
2016
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:192](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/funcs/event-client.ts#L192)
2016
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:192](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/funcs/event-client.ts#L192)
2017
2017
 
2018
2018
  unforward local event(s) to server
2019
2019
 
@@ -2037,7 +2037,7 @@ Note: pls backendEventable(ClientTools or EventClient) first
2037
2037
 
2038
2038
  > **unregister**(): `any`
2039
2039
 
2040
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:619](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L619)
2040
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:619](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L619)
2041
2041
 
2042
2042
  Removes the current `ToolFunc` instance from the static registry.
2043
2043
 
@@ -2057,7 +2057,7 @@ The instance that was unregistered.
2057
2057
 
2058
2058
  > **unsubscribe**(`events`): `Promise`\<`any`\>
2059
2059
 
2060
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:148](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/funcs/event-client.ts#L148)
2060
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:148](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/funcs/event-client.ts#L148)
2061
2061
 
2062
2062
  unsubscribe server event
2063
2063
 
@@ -2473,7 +2473,7 @@ Object that contains the properties and methods. This can be an object that you
2473
2473
 
2474
2474
  > `static` **fetch**(`name`, `objParam?`, ...`args?`): `Promise`\<`any`\>
2475
2475
 
2476
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:99](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/client-tools.ts#L99)
2476
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:99](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/client-tools.ts#L99)
2477
2477
 
2478
2478
  #### Parameters
2479
2479
 
@@ -2659,7 +2659,7 @@ An iterable object that contains key-value entries for properties and methods.
2659
2659
 
2660
2660
  > `static` **get**(`name`): [`ToolFunc`](ToolFunc.md)
2661
2661
 
2662
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:319](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L319)
2662
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:319](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L319)
2663
2663
 
2664
2664
  Retrieves a registered function by its name or alias.
2665
2665
 
@@ -2687,7 +2687,7 @@ The `ToolFunc` instance if found, otherwise `undefined`.
2687
2687
 
2688
2688
  > `static` **getAllByTag**(`tagName`): [`ToolFunc`](ToolFunc.md)[]
2689
2689
 
2690
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:365](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L365)
2690
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:365](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L365)
2691
2691
 
2692
2692
  Retrieves all registered functions that have a specific tag.
2693
2693
 
@@ -2715,7 +2715,7 @@ An array of matching `ToolFunc` instances.
2715
2715
 
2716
2716
  > `static` **getByTag**(`tagName`): `undefined` \| [`ToolFunc`](ToolFunc.md)
2717
2717
 
2718
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:340](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L340)
2718
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:340](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L340)
2719
2719
 
2720
2720
  Finds the first registered function that has a specific tag.
2721
2721
 
@@ -2743,7 +2743,7 @@ The first matching `ToolFunc` instance, or `undefined` if none is found.
2743
2743
 
2744
2744
  > `static` **getFunc**(`name`): `any`
2745
2745
 
2746
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:431](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L431)
2746
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:431](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L431)
2747
2747
 
2748
2748
  Retrieves a bound, runnable function reference for a registered function.
2749
2749
  This reference is suitable for execution with an object of named parameters.
@@ -2772,7 +2772,7 @@ A bound function reference, or `undefined` if not found.
2772
2772
 
2773
2773
  > `static` **getFuncWithPos**(`name`): `any`
2774
2774
 
2775
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:472](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L472)
2775
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:472](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L472)
2776
2776
 
2777
2777
  Retrieves a bound, runnable function reference for a registered function.
2778
2778
  This reference is suitable for execution with positional arguments.
@@ -2963,7 +2963,7 @@ The object that references the prototype.
2963
2963
 
2964
2964
  > `static` **hasAsyncFeature**(`feature`): `boolean`
2965
2965
 
2966
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:388](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L388)
2966
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:388](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L388)
2967
2967
 
2968
2968
  Checks if any registered function has a specific asynchronous feature.
2969
2969
 
@@ -3183,7 +3183,7 @@ Object that contains the properties and methods. This can be an object that you
3183
3183
 
3184
3184
  > `static` **list**(): [`Funcs`](../interfaces/Funcs.md)
3185
3185
 
3186
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:331](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L331)
3186
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:331](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L331)
3187
3187
 
3188
3188
  Returns the complete map of all registered functions.
3189
3189
 
@@ -3203,7 +3203,7 @@ The map of `ToolFunc` instances.
3203
3203
 
3204
3204
  > `static` **loadFrom**(`items?`): `Promise`\<[`Funcs`](../interfaces/Funcs.md)\>
3205
3205
 
3206
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:69](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/client-tools.ts#L69)
3206
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:69](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/client-tools.ts#L69)
3207
3207
 
3208
3208
  Loads tool definitions from the remote server via the configured transport.
3209
3209
  This method populates the local `ToolFunc` registry with `ClientTools` stubs.
@@ -3228,7 +3228,7 @@ This method populates the local `ToolFunc` registry with `ClientTools` stubs.
3228
3228
 
3229
3229
  > `static` **loadFromSync**(`items`): `void`
3230
3230
 
3231
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:85](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/client-tools.ts#L85)
3231
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:85](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/client-tools.ts#L85)
3232
3232
 
3233
3233
  Synchronously loads tool definitions from a provided object, registering
3234
3234
  each one as a `ClientTools` instance.
@@ -3289,7 +3289,7 @@ Object to make non-extensible.
3289
3289
 
3290
3290
  > `static` **register**(`name`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
3291
3291
 
3292
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:495](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L495)
3292
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:495](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L495)
3293
3293
 
3294
3294
  Registers a new tool function.
3295
3295
 
@@ -3321,7 +3321,7 @@ The new `ToolFunc` instance, or `false` if a function with that name already exi
3321
3321
 
3322
3322
  > `static` **register**(`func`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
3323
3323
 
3324
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:496](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L496)
3324
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:496](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L496)
3325
3325
 
3326
3326
  Registers a new tool function.
3327
3327
 
@@ -3353,7 +3353,7 @@ The new `ToolFunc` instance, or `false` if a function with that name already exi
3353
3353
 
3354
3354
  > `static` **register**(`name`, `options?`): `boolean` \| [`ToolFunc`](ToolFunc.md)
3355
3355
 
3356
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:497](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L497)
3356
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:497](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L497)
3357
3357
 
3358
3358
  Registers a new tool function.
3359
3359
 
@@ -3387,7 +3387,7 @@ The new `ToolFunc` instance, or `false` if a function with that name already exi
3387
3387
 
3388
3388
  > `static` **run**(`name`, `params?`): `Promise`\<`any`\>
3389
3389
 
3390
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:402](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L402)
3390
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:402](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L402)
3391
3391
 
3392
3392
  Asynchronously executes a registered function by name with named parameters.
3393
3393
 
@@ -3425,7 +3425,7 @@ If the function with the given name is not found.
3425
3425
 
3426
3426
  > `static` **runSync**(`name`, `params?`): `any`
3427
3427
 
3428
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:417](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L417)
3428
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:417](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L417)
3429
3429
 
3430
3430
  Synchronously executes a registered function by name with named parameters.
3431
3431
 
@@ -3463,7 +3463,7 @@ If the function with the given name is not found.
3463
3463
 
3464
3464
  > `static` **runWithPos**(`name`, ...`params`): `Promise`\<`any`\>
3465
3465
 
3466
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:443](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L443)
3466
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:443](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L443)
3467
3467
 
3468
3468
  Asynchronously executes a function using positional arguments.
3469
3469
 
@@ -3501,7 +3501,7 @@ If the function with the given name is not found.
3501
3501
 
3502
3502
  > `static` **runWithPosSync**(`name`, ...`params`): `any`
3503
3503
 
3504
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:458](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L458)
3504
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:458](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L458)
3505
3505
 
3506
3506
  Synchronously executes a function using positional arguments.
3507
3507
 
@@ -3603,7 +3603,7 @@ The value of the new prototype or null.
3603
3603
 
3604
3604
  > `static` **setPubSubTransport**(`t?`): `void`
3605
3605
 
3606
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:17](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/funcs/event-client.ts#L17)
3606
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:17](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/funcs/event-client.ts#L17)
3607
3607
 
3608
3608
  #### Parameters
3609
3609
 
@@ -3621,7 +3621,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:17](https
3621
3621
 
3622
3622
  > `static` **setTransport**(`transport`): `void`
3623
3623
 
3624
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:51](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/client-tools.ts#L51)
3624
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:51](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/client-tools.ts#L51)
3625
3625
 
3626
3626
  Injects the client-side transport implementation. This is a crucial step
3627
3627
  to enable communication with the server.
@@ -3648,7 +3648,7 @@ The transport instance to use for all client-server communication.
3648
3648
 
3649
3649
  > `static` **unregister**(`name`): `undefined` \| [`ToolFunc`](ToolFunc.md)
3650
3650
 
3651
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:547](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L547)
3651
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:547](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L547)
3652
3652
 
3653
3653
  Unregisters a function by its name, also removing any associated aliases.
3654
3654