@isdk/ai-tool 0.6.0 → 0.7.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 (473) hide show
  1. package/README.cn.md +103 -237
  2. package/README.md +101 -186
  3. package/dist/chunk-4XRPAC7C.mjs +1 -0
  4. package/dist/chunk-VIG2GB47.mjs +1 -1
  5. package/dist/funcs.d.mts +1 -1
  6. package/dist/funcs.d.ts +1 -1
  7. package/dist/funcs.js +1 -1
  8. package/dist/funcs.mjs +1 -1
  9. package/dist/index-DEUnmyUq.d.mts +1792 -0
  10. package/dist/index-DEUnmyUq.d.ts +1792 -0
  11. package/dist/index.d.mts +1068 -9
  12. package/dist/index.d.ts +1068 -9
  13. package/dist/index.js +1 -1
  14. package/dist/index.mjs +1 -1
  15. package/dist/test/util.js +1 -1
  16. package/docs/api/README.md +165 -0
  17. package/docs/{_media → api/_media}/CONTRIBUTING.md +3 -3
  18. package/docs/api/_media/pubsub.md +326 -0
  19. package/docs/api/_media/server_client_tools.md +88 -0
  20. package/docs/api/_media/toolFunc.md +183 -0
  21. package/docs/api/_media/transport.md +137 -0
  22. package/docs/{classes → api/classes}/AbortError.md +139 -54
  23. package/docs/api/classes/AlreadyExistsError.md +431 -0
  24. package/docs/api/classes/BaseError.md +440 -0
  25. package/docs/{classes → api/classes}/BinarySemaphore.md +25 -25
  26. package/docs/{classes → api/classes}/CancelableAbility.md +25 -25
  27. package/docs/api/classes/ClientToolTransport.md +310 -0
  28. package/docs/{classes → api/classes}/ClientTools.md +646 -180
  29. package/docs/{classes → api/classes}/CommonError.md +139 -54
  30. package/docs/{classes → api/classes}/ConfigFile.md +54 -5
  31. package/docs/{classes → api/classes}/EnvPromptTemplate.md +94 -48
  32. package/docs/{classes → api/classes}/EventClient.md +742 -234
  33. package/docs/{classes → api/classes}/EventEmitter.md +12 -12
  34. package/docs/{classes → api/classes}/EventServer.md +670 -209
  35. package/docs/{classes → api/classes}/EventToolFunc.md +561 -109
  36. package/docs/{classes → api/classes}/FStringPromptTemplate.md +94 -48
  37. package/docs/{classes → api/classes}/FewShotPromptTemplate.md +100 -52
  38. package/docs/{classes → api/classes}/GolangPromptTemplate.md +99 -53
  39. package/docs/api/classes/HttpClientToolTransport.md +324 -0
  40. package/docs/api/classes/HttpServerToolTransport.md +332 -0
  41. package/docs/{classes → api/classes}/IntSet.md +12 -12
  42. package/docs/{classes → api/classes}/LRUCache.md +26 -26
  43. package/docs/api/classes/NotFoundError.md +431 -0
  44. package/docs/api/classes/NotImplementationError.md +431 -0
  45. package/docs/{classes → api/classes}/PromptExampleSelector.md +9 -9
  46. package/docs/{classes → api/classes}/PromptTemplate.md +91 -47
  47. package/docs/api/classes/ReadableStreamError.md +451 -0
  48. package/docs/api/classes/ResClientTools.md +3365 -0
  49. package/docs/api/classes/ResServerTools.md +3342 -0
  50. package/docs/api/classes/RpcMethodsClientTool.md +3275 -0
  51. package/docs/api/classes/RpcMethodsServerTool.md +3224 -0
  52. package/docs/api/classes/SSEChannel.md +272 -0
  53. package/docs/{classes → api/classes}/Semaphore.md +26 -26
  54. package/docs/api/classes/ServerToolTransport.md +323 -0
  55. package/docs/{classes → api/classes}/ServerTools.md +583 -120
  56. package/docs/{classes → api/classes}/SignalGate.md +9 -9
  57. package/docs/api/classes/SseClientPubSubTransport.md +92 -0
  58. package/docs/api/classes/SseServerPubSubTransport.md +234 -0
  59. package/docs/{classes → api/classes}/TaskAbortController.md +9 -9
  60. package/docs/api/classes/ToolFunc.md +2665 -0
  61. package/docs/api/classes/ToolTransport.md +143 -0
  62. package/docs/api/classes/YamlTypeBaseObject.md +31 -0
  63. package/docs/api/enumerations/AsyncFeatureBits.md +33 -0
  64. package/docs/api/enumerations/AsyncFeatures.md +33 -0
  65. package/docs/api/enumerations/ErrorCode.md +177 -0
  66. package/docs/api/enumerations/HashAlgorithm.md +97 -0
  67. package/docs/{functions → api/functions}/AIArgProcessor.md +1 -1
  68. package/docs/{functions → api/functions}/AIStream.md +1 -1
  69. package/docs/{functions → api/functions}/ChoiceArgProcessor.md +1 -1
  70. package/docs/api/functions/DefaultDateFormat.md +21 -0
  71. package/docs/{functions → api/functions}/ObjectArgsToArgsInfo.md +1 -1
  72. package/docs/{functions → api/functions}/RateLimit.md +1 -1
  73. package/docs/{functions → api/functions}/TemplateArgProcessor.md +1 -1
  74. package/docs/api/functions/addDate.md +71 -0
  75. package/docs/{functions → api/functions}/assignDirs.md +1 -1
  76. package/docs/{functions → api/functions}/backendEventable.md +1 -1
  77. package/docs/{functions → api/functions}/beforeShutdown.md +1 -1
  78. package/docs/api/functions/calcPerplexity.md +60 -0
  79. package/docs/api/functions/calcPerplexitySimple.md +42 -0
  80. package/docs/api/functions/canonicalize.md +33 -0
  81. package/docs/{functions → api/functions}/completeSentences.md +1 -1
  82. package/docs/{functions → api/functions}/concatText.md +1 -1
  83. package/docs/{functions → api/functions}/countLLMTokens.md +1 -1
  84. package/docs/{functions → api/functions}/countRegexMatches.md +1 -1
  85. package/docs/{functions → api/functions}/createAbilityInjector.md +4 -4
  86. package/docs/{functions → api/functions}/createCallbacksTransformer.md +1 -1
  87. package/docs/{functions → api/functions}/createEmptyReadableStream.md +1 -1
  88. package/docs/{functions → api/functions}/createEndWithRepetitionDetector.md +1 -1
  89. package/docs/{functions → api/functions}/createError.md +1 -1
  90. package/docs/{functions → api/functions}/createEventStreamTransformer.md +1 -1
  91. package/docs/{functions → api/functions}/createHfValueFunc.md +1 -1
  92. package/docs/{functions → api/functions}/createLRUCache.md +1 -1
  93. package/docs/{functions → api/functions}/createYamlObjectTag.md +1 -1
  94. package/docs/{functions → api/functions}/dateToText.md +1 -1
  95. package/docs/{functions → api/functions}/decodeCharset.md +1 -1
  96. package/docs/api/functions/defaultsWithConcat.md +74 -0
  97. package/docs/{functions → api/functions}/detectCharset.md +1 -1
  98. package/docs/{functions → api/functions}/encodeLLMTokens.md +1 -1
  99. package/docs/{functions → api/functions}/ensureQuoted.md +1 -1
  100. package/docs/{functions → api/functions}/eventable.md +1 -1
  101. package/docs/{functions → api/functions}/expandConfig.md +1 -1
  102. package/docs/{functions → api/functions}/expandEnv.md +1 -1
  103. package/docs/{functions → api/functions}/expandObjEnv.md +1 -1
  104. package/docs/{functions → api/functions}/expandPath.md +1 -1
  105. package/docs/api/functions/expandPathInObject.md +29 -0
  106. package/docs/api/functions/expandPaths.md +25 -0
  107. package/docs/{functions → api/functions}/extNameLevel.md +1 -1
  108. package/docs/{functions → api/functions}/fileIsExists.md +1 -1
  109. package/docs/{functions → api/functions}/filterValidFnScope.md +1 -1
  110. package/docs/{functions → api/functions}/findIndexNonEmptyFrom.md +1 -1
  111. package/docs/{functions → api/functions}/findPort.md +1 -1
  112. package/docs/{functions → api/functions}/formatISO.md +1 -1
  113. package/docs/{functions → api/functions}/formatTextWithSpace.md +1 -1
  114. package/docs/api/functions/funcGetMeta.md +27 -0
  115. package/docs/api/functions/funcWithMeta.md +41 -0
  116. package/docs/api/functions/genUrlParamsStr.md +27 -0
  117. package/docs/{functions → api/functions}/getAllEnumKeys.md +1 -1
  118. package/docs/{functions → api/functions}/getConfigFileNames.md +1 -1
  119. package/docs/{functions → api/functions}/getConfigs.md +1 -1
  120. package/docs/{functions → api/functions}/getEnvVairables.md +1 -1
  121. package/docs/{functions → api/functions}/getFileMetaInfo.md +1 -1
  122. package/docs/{functions → api/functions}/getHashAlgoBySize.md +1 -1
  123. package/docs/{functions → api/functions}/getKeysPath.md +1 -1
  124. package/docs/{functions → api/functions}/getLLMTokenizer.md +1 -1
  125. package/docs/{functions → api/functions}/getMultiLevelExtname.md +1 -1
  126. package/docs/{functions → api/functions}/getPackageDir.md +1 -1
  127. package/docs/{functions → api/functions}/getRealFilepath.md +1 -1
  128. package/docs/{functions → api/functions}/getResponseErrorReadableStream.md +1 -1
  129. package/docs/{functions → api/functions}/getXDGConfigs.md +1 -1
  130. package/docs/{functions → api/functions}/hasDirectoryIn.md +1 -1
  131. package/docs/{functions → api/functions}/hash.md +1 -1
  132. package/docs/{functions → api/functions}/hashFile.md +1 -1
  133. package/docs/api/functions/hashObject.md +25 -0
  134. package/docs/{functions → api/functions}/hashStream.md +1 -1
  135. package/docs/api/functions/initShutdown.md +15 -0
  136. package/docs/{functions → api/functions}/isLangUsingSpaces.md +1 -1
  137. package/docs/{functions → api/functions}/isListItemString.md +1 -1
  138. package/docs/{functions → api/functions}/isModelNameMatched.md +1 -1
  139. package/docs/{functions → api/functions}/isPunctuationChar.md +1 -1
  140. package/docs/{functions → api/functions}/isQuoted.md +1 -1
  141. package/docs/{functions → api/functions}/isRegExp.md +1 -1
  142. package/docs/{functions → api/functions}/isSameString.md +1 -1
  143. package/docs/{functions → api/functions}/isSectionString.md +1 -1
  144. package/docs/{functions → api/functions}/isSentenceEnding.md +1 -1
  145. package/docs/{functions → api/functions}/isSepLineString.md +1 -1
  146. package/docs/{functions → api/functions}/isStrWrapped.md +1 -1
  147. package/docs/{functions → api/functions}/isSubdirectory.md +2 -2
  148. package/docs/{functions → api/functions}/isTitleString.md +1 -1
  149. package/docs/{functions → api/functions}/isValidFilename.md +1 -1
  150. package/docs/{functions → api/functions}/isValidFilepath.md +1 -1
  151. package/docs/{functions → api/functions}/isWebStream.md +1 -1
  152. package/docs/api/functions/joinSplitWords.md +46 -0
  153. package/docs/{functions → api/functions}/jsonFilterToWhere.md +1 -1
  154. package/docs/{functions → api/functions}/jsonToMarkdownStr.md +9 -1
  155. package/docs/{functions → api/functions}/loadAIConfig.md +1 -1
  156. package/docs/{functions → api/functions}/loadConfig.md +1 -1
  157. package/docs/{functions → api/functions}/loadConfigFile.md +1 -1
  158. package/docs/{functions → api/functions}/loadFileFromPaths.md +1 -1
  159. package/docs/{functions → api/functions}/loadTextFromPaths.md +1 -1
  160. package/docs/{functions → api/functions}/lrucache.md +1 -1
  161. package/docs/{functions → api/functions}/makeToolFuncCancelable.md +1 -1
  162. package/docs/{functions → api/functions}/matchUrlProtocol.md +1 -1
  163. package/docs/{functions → api/functions}/memoize.md +1 -1
  164. package/docs/api/functions/mergeArray.md +57 -0
  165. package/docs/{functions → api/functions}/messagesToText.md +1 -1
  166. package/docs/api/functions/normalizePath.md +21 -0
  167. package/docs/{functions → api/functions}/paramsSizeToScaleStr.md +1 -1
  168. package/docs/{functions → api/functions}/parseCommand.md +1 -1
  169. package/docs/{functions → api/functions}/parseDateFormat.md +1 -1
  170. package/docs/{functions → api/functions}/parseISO.md +1 -1
  171. package/docs/{functions → api/functions}/parseJsJson.md +1 -1
  172. package/docs/{functions → api/functions}/parseJsJsonSimpleSync.md +1 -1
  173. package/docs/{functions → api/functions}/parseObjectArgInfo.md +1 -1
  174. package/docs/{functions → api/functions}/parseObjectArgumentInfos.md +1 -1
  175. package/docs/{functions → api/functions}/parseObjectArguments.md +1 -1
  176. package/docs/{functions → api/functions}/parseObjectArgumentsAsArgInfos.md +1 -1
  177. package/docs/{functions → api/functions}/parseYaml.md +1 -1
  178. package/docs/api/functions/pruneSubdirectories.md +35 -0
  179. package/docs/api/functions/pruneSubdirectoriesInPlace.md +38 -0
  180. package/docs/{functions → api/functions}/quoteStr.md +1 -1
  181. package/docs/{functions → api/functions}/readFilenamesRecursiveSync.md +1 -1
  182. package/docs/{functions → api/functions}/readTextFileChunks.md +1 -1
  183. package/docs/{functions → api/functions}/readTextFileChunksEx.md +1 -1
  184. package/docs/{functions → api/functions}/readableFromAsyncIterable.md +1 -1
  185. package/docs/{functions → api/functions}/registerCoreTools.md +1 -1
  186. package/docs/{functions → api/functions}/registerYamlTag.md +1 -1
  187. package/docs/{functions → api/functions}/removeMarkdownBold.md +1 -1
  188. package/docs/{functions → api/functions}/removeMarkdownBoldAndItalic.md +1 -1
  189. package/docs/{functions → api/functions}/removeMarkdownItalic.md +1 -1
  190. package/docs/{functions → api/functions}/replaceWithPlaceholder.md +1 -1
  191. package/docs/{functions → api/functions}/restoreFromPlacehoders.md +1 -1
  192. package/docs/{functions → api/functions}/sanitizeFilename.md +1 -1
  193. package/docs/{functions → api/functions}/sanitizeFilepath.md +1 -1
  194. package/docs/{functions → api/functions}/saveConfigFile.md +1 -1
  195. package/docs/{functions → api/functions}/scaleStrToParamsSize.md +1 -1
  196. package/docs/{functions → api/functions}/shutdown.md +1 -1
  197. package/docs/{functions → api/functions}/simplifyObjectArguments.md +1 -1
  198. package/docs/api/functions/sleep.md +36 -0
  199. package/docs/{functions → api/functions}/sortedValues.md +1 -1
  200. package/docs/{functions → api/functions}/splitChunks.md +1 -1
  201. package/docs/{functions → api/functions}/splitParagraph.md +1 -1
  202. package/docs/{functions → api/functions}/splitSentence.md +1 -1
  203. package/docs/api/functions/splitWords.md +42 -0
  204. package/docs/{functions → api/functions}/stringifyYaml.md +1 -1
  205. package/docs/{functions → api/functions}/stripConsoleColor.md +1 -1
  206. package/docs/{functions → api/functions}/textToDate.md +1 -1
  207. package/docs/{functions → api/functions}/throwError.md +3 -3
  208. package/docs/{functions → api/functions}/toDate.md +1 -1
  209. package/docs/{functions → api/functions}/toDateTime.md +1 -1
  210. package/docs/{functions → api/functions}/toRegExp.md +1 -1
  211. package/docs/{functions → api/functions}/trimStartOfStreamHelper.md +1 -1
  212. package/docs/{functions → api/functions}/truncTo.md +1 -1
  213. package/docs/{functions → api/functions}/truncateByToken.md +1 -1
  214. package/docs/{functions → api/functions}/truncateToTokenLimit.md +1 -1
  215. package/docs/{functions → api/functions}/truncateToTokenLimitEx.md +1 -1
  216. package/docs/{functions → api/functions}/uuid.md +1 -1
  217. package/docs/{functions → api/functions}/uuidParse.md +1 -1
  218. package/docs/{functions → api/functions}/uuidStringify.md +1 -1
  219. package/docs/{functions → api/functions}/uuidValidate.md +1 -1
  220. package/docs/{functions → api/functions}/uuidVersion.md +1 -1
  221. package/docs/{functions → api/functions}/uuidv1.md +9 -5
  222. package/docs/{functions → api/functions}/uuidv4.md +9 -5
  223. package/docs/{functions → api/functions}/uuidv5.md +9 -5
  224. package/docs/api/functions/wait.md +45 -0
  225. package/docs/{functions → api/functions}/wrapEventEmitter.md +1 -1
  226. package/docs/{functions → api/functions}/xxhash.md +1 -1
  227. package/docs/{functions → api/functions}/xxhash32.md +1 -1
  228. package/docs/{functions → api/functions}/xxhash64.md +1 -1
  229. package/docs/{functions → api/functions}/xxhashAsStr.md +1 -1
  230. package/docs/api/functions/yieldExec.md +27 -0
  231. package/docs/{globals.md → api/globals.md} +50 -1
  232. package/docs/api/interfaces/AIChatAssistantMessageParam.md +129 -0
  233. package/docs/api/interfaces/AIChatContentPartImage.md +29 -0
  234. package/docs/api/interfaces/AIChatContentPartText.md +25 -0
  235. package/docs/api/interfaces/AIChatMessageParamBase.md +68 -0
  236. package/docs/api/interfaces/AIChatMessageToolCall.md +41 -0
  237. package/docs/{interfaces → api/interfaces}/AIChatSystemMessageParam.md +9 -9
  238. package/docs/api/interfaces/AIChatToolChoiceFuncObject.md +37 -0
  239. package/docs/api/interfaces/AIChatToolChoiceObject.md +25 -0
  240. package/docs/api/interfaces/AIChatToolFunc.md +41 -0
  241. package/docs/api/interfaces/AIChatToolFuncParam.md +37 -0
  242. package/docs/api/interfaces/AIChatToolMessageParam.md +113 -0
  243. package/docs/api/interfaces/AIChatToolParam.md +25 -0
  244. package/docs/api/interfaces/AIChatToolTypeObject.md +17 -0
  245. package/docs/api/interfaces/AIChatUserMessageParam.md +137 -0
  246. package/docs/api/interfaces/AIChoiceConfig.md +65 -0
  247. package/docs/api/interfaces/AIResult.md +65 -0
  248. package/docs/{interfaces → api/interfaces}/AIStreamParser.md +2 -2
  249. package/docs/api/interfaces/AIStreamParserOptions.md +21 -0
  250. package/docs/api/interfaces/BaseFunc.md +299 -0
  251. package/docs/api/interfaces/BaseFuncItem.md +221 -0
  252. package/docs/api/interfaces/BinarySemaphoreAcquireOptions.md +25 -0
  253. package/docs/api/interfaces/BinarySemaphoreOptions.md +57 -0
  254. package/docs/api/interfaces/BinarySemaphoreReleaseOptions.md +25 -0
  255. package/docs/api/interfaces/BinarySemaphoreReleaserFunc.md +37 -0
  256. package/docs/api/interfaces/CancelableAbilityOptions.md +113 -0
  257. package/docs/api/interfaces/ClientFuncItem.md +326 -0
  258. package/docs/api/interfaces/EventClientFuncParams.md +51 -0
  259. package/docs/api/interfaces/EventServerFuncParams.md +73 -0
  260. package/docs/{interfaces → api/interfaces}/FewShotPromptTemplateOptions.md +24 -12
  261. package/docs/api/interfaces/FuncItem.md +281 -0
  262. package/docs/api/interfaces/FuncParam.md +51 -0
  263. package/docs/api/interfaces/FuncParams.md +28 -0
  264. package/docs/api/interfaces/Funcs.md +15 -0
  265. package/docs/api/interfaces/HashAlgoParams.md +33 -0
  266. package/docs/api/interfaces/IClientToolTransport.md +155 -0
  267. package/docs/api/interfaces/IFileMetaInfo.md +65 -0
  268. package/docs/api/interfaces/IPubSubClientTransport.md +70 -0
  269. package/docs/api/interfaces/IPubSubServerTransport.md +241 -0
  270. package/docs/api/interfaces/IReadTextFileChunksOptions.md +143 -0
  271. package/docs/api/interfaces/IServerToolTransport.md +159 -0
  272. package/docs/api/interfaces/IToolTransport.md +73 -0
  273. package/docs/api/interfaces/ITruncateToTokenLimitOptions.md +99 -0
  274. package/docs/api/interfaces/JsonFilter.md +13 -0
  275. package/docs/api/interfaces/ParseObjectArgumentOptions.md +89 -0
  276. package/docs/api/interfaces/ProbabilityItem.md +41 -0
  277. package/docs/api/interfaces/PromptExampleSelectorOptions.md +34 -0
  278. package/docs/{interfaces → api/interfaces}/PromptTemplateOptions.md +15 -7
  279. package/docs/api/interfaces/PubSubClient.md +27 -0
  280. package/docs/api/interfaces/PubSubClientStream.md +196 -0
  281. package/docs/api/interfaces/PubSubServerSession.md +103 -0
  282. package/docs/api/interfaces/RemoteFuncItem.md +316 -0
  283. package/docs/api/interfaces/ReplacePlacehoderOptions.md +41 -0
  284. package/docs/api/interfaces/ResClientFuncParams.md +37 -0
  285. package/docs/api/interfaces/ResServerFuncParams.md +77 -0
  286. package/docs/api/interfaces/RpcMethodsClientFuncParams.md +25 -0
  287. package/docs/api/interfaces/RpcMethodsServerFuncParams.md +61 -0
  288. package/docs/api/interfaces/SanitizeFilenameOptions.md +25 -0
  289. package/docs/api/interfaces/SectionStringOptions.md +25 -0
  290. package/docs/api/interfaces/SemaphoreOptions.md +89 -0
  291. package/docs/api/interfaces/SemaphoreTaskItem.md +73 -0
  292. package/docs/api/interfaces/ServerFuncItem.md +339 -0
  293. package/docs/api/interfaces/ServerFuncParams.md +42 -0
  294. package/docs/api/interfaces/SplitSentenceOptions.md +41 -0
  295. package/docs/{interfaces → api/interfaces}/StreamCallbacksAndOptions.md +5 -5
  296. package/docs/{interfaces → api/interfaces}/TaskAbortControllers.md +1 -1
  297. package/docs/{interfaces → api/interfaces}/TaskPromise.md +6 -6
  298. package/docs/api/interfaces/ToolFuncPackage.md +57 -0
  299. package/docs/{namespaces → api/namespaces}/EventStates/variables/ABORT.md +1 -1
  300. package/docs/{namespaces → api/namespaces}/EventStates/variables/CONTINUE.md +1 -1
  301. package/docs/{namespaces → api/namespaces}/EventStates/variables/DONE.md +1 -1
  302. package/docs/{namespaces → api/namespaces}/EventStates/variables/STOPPED.md +1 -1
  303. package/docs/{namespaces → api/namespaces}/uuidv5/variables/DNS.md +1 -1
  304. package/docs/{namespaces → api/namespaces}/uuidv5/variables/URL.md +1 -1
  305. package/docs/{type-aliases → api/type-aliases}/AIChatContentPart.md +1 -1
  306. package/docs/{type-aliases → api/type-aliases}/AIChatMessageParam.md +1 -1
  307. package/docs/{type-aliases → api/type-aliases}/AIChatRole.md +1 -1
  308. package/docs/{type-aliases → api/type-aliases}/AIChatToolChoiceParam.md +1 -1
  309. package/docs/{type-aliases → api/type-aliases}/AIMessageType.md +1 -1
  310. package/docs/api/type-aliases/AIModelNameRule.md +14 -0
  311. package/docs/api/type-aliases/AIModelNameRuleFn.md +28 -0
  312. package/docs/api/type-aliases/AIModelNameRules.md +13 -0
  313. package/docs/{type-aliases → api/type-aliases}/AITextGenerationFinishReason.md +1 -1
  314. package/docs/api/type-aliases/ActionName.md +13 -0
  315. package/docs/api/type-aliases/ArrayMergeWay.md +11 -0
  316. package/docs/api/type-aliases/AsyncTaskId.md +11 -0
  317. package/docs/{type-aliases → api/type-aliases}/BeforeShutdownListener.md +1 -1
  318. package/docs/{type-aliases → api/type-aliases}/EventErrorListenerFn.md +1 -1
  319. package/docs/{type-aliases → api/type-aliases}/EventListenerFn.md +1 -1
  320. package/docs/api/type-aliases/FuncParamType.md +13 -0
  321. package/docs/{type-aliases → api/type-aliases}/PromptExamples.md +1 -1
  322. package/docs/api/type-aliases/PubSubClientId.md +14 -0
  323. package/docs/api/type-aliases/PubSubCtx.md +37 -0
  324. package/docs/api/type-aliases/RpcMethodHandler.md +34 -0
  325. package/docs/{type-aliases → api/type-aliases}/SemaphoreIsReadyFuncType.md +1 -1
  326. package/docs/api/type-aliases/TFunc.md +33 -0
  327. package/docs/{variables → api/variables}/AIChatRoles.md +1 -1
  328. package/docs/{variables → api/variables}/AIMessageTypes.md +1 -1
  329. package/docs/{variables → api/variables}/AITextGenerationFinishReasons.md +1 -1
  330. package/docs/{variables → api/variables}/AbortErrorCode.md +1 -1
  331. package/docs/api/variables/ActionNames.md +13 -0
  332. package/docs/{variables → api/variables}/AlreadyExistsErrorCode.md +1 -1
  333. package/docs/api/variables/ArrayMergeWay.md +25 -0
  334. package/docs/api/variables/ArrayMergeWaySymbol.md +11 -0
  335. package/docs/api/variables/ClientToolFuncSchema.md +83 -0
  336. package/docs/{variables → api/variables}/DEFAULT_CONFIG_NAME.md +1 -1
  337. package/docs/{variables → api/variables}/DefaultAsyncSemaphoreCapacity.md +1 -1
  338. package/docs/api/variables/EventBusName.md +11 -0
  339. package/docs/api/variables/EventName.md +11 -0
  340. package/docs/{variables → api/variables}/FilenameReservedRegex.md +1 -1
  341. package/docs/api/variables/FuncMetaSymbol.md +15 -0
  342. package/docs/{variables → api/variables}/InternalErrorCode.md +1 -1
  343. package/docs/{variables → api/variables}/LLM_TOKENIZER_NAMES.md +1 -1
  344. package/docs/{variables → api/variables}/LLM_TOKENIZER_NAMES_MAP.md +1 -1
  345. package/docs/{variables → api/variables}/NotFoundErrorCode.md +1 -1
  346. package/docs/{variables → api/variables}/NotImplementedErrorCode.md +1 -1
  347. package/docs/api/variables/PASSING_SCORE.md +13 -0
  348. package/docs/api/variables/RStreamErrCode.md +11 -0
  349. package/docs/api/variables/RemoteToolFuncSchema.md +84 -0
  350. package/docs/api/variables/ResponseRStreamErrCode.md +11 -0
  351. package/docs/api/variables/RpcMethodsClientToolSchema.md +49 -0
  352. package/docs/api/variables/RpcMethodsServerToolSchema.md +21 -0
  353. package/docs/{variables → api/variables}/SHUTDOWN_SIGNALS.md +1 -1
  354. package/docs/{variables → api/variables}/SSEChannelAlreadyClosedErrCode.md +1 -1
  355. package/docs/api/variables/SecondaryCache.md +11 -0
  356. package/docs/api/variables/ServerToolFuncSchema.md +83 -0
  357. package/docs/api/variables/StrangeHumanName.md +11 -0
  358. package/docs/api/variables/ToolAsyncCancelableBit.md +11 -0
  359. package/docs/api/variables/ToolAsyncMultiTaskBit.md +11 -0
  360. package/docs/api/variables/ToolAsyncPriorityBit.md +11 -0
  361. package/docs/{variables → api/variables}/ToolFuncSchema.md +14 -1
  362. package/docs/{variables → api/variables}/WindowsReservedNameRegex.md +1 -1
  363. package/docs/api/variables/base32768.md +11 -0
  364. package/docs/{variables → api/variables}/defaultTemplateFormat.md +1 -1
  365. package/docs/api/variables/event.md +11 -0
  366. package/docs/api/variables/eventClient.md +11 -0
  367. package/docs/api/variables/eventServer.md +11 -0
  368. package/docs/api/variables/lrucache.md +11 -0
  369. package/docs/{variables → api/variables}/mimeType.md +1 -1
  370. package/docs/{variables → api/variables}/uuidNIL.md +1 -1
  371. package/docs/pubsub.md +326 -0
  372. package/docs/server_client_tools.md +88 -0
  373. package/docs/toolFunc.md +183 -0
  374. package/docs/transport.md +137 -0
  375. package/package.json +37 -39
  376. package/dist/chunk-OYDBRUZJ.mjs +0 -1
  377. package/dist/index-BkwhCK1q.d.mts +0 -899
  378. package/dist/index-BkwhCK1q.d.ts +0 -899
  379. package/docs/README.md +0 -250
  380. package/docs/classes/AlreadyExistsError.md +0 -346
  381. package/docs/classes/BaseError.md +0 -359
  382. package/docs/classes/NotFoundError.md +0 -346
  383. package/docs/classes/NotImplementationError.md +0 -346
  384. package/docs/classes/ReadableStreamError.md +0 -366
  385. package/docs/classes/ResClientTools.md +0 -2451
  386. package/docs/classes/ResServerTools.md +0 -2427
  387. package/docs/classes/SSEChannel.md +0 -270
  388. package/docs/classes/ToolFunc.md +0 -2201
  389. package/docs/classes/YamlTypeBaseObject.md +0 -31
  390. package/docs/enumerations/AsyncFeatureBits.md +0 -33
  391. package/docs/enumerations/AsyncFeatures.md +0 -33
  392. package/docs/enumerations/ErrorCode.md +0 -177
  393. package/docs/enumerations/HashAlgorithm.md +0 -97
  394. package/docs/functions/canonicalize.md +0 -21
  395. package/docs/functions/initShutdown.md +0 -15
  396. package/docs/functions/wait.md +0 -21
  397. package/docs/interfaces/AIChatAssistantMessageParam.md +0 -129
  398. package/docs/interfaces/AIChatContentPartImage.md +0 -29
  399. package/docs/interfaces/AIChatContentPartText.md +0 -25
  400. package/docs/interfaces/AIChatMessageParamBase.md +0 -68
  401. package/docs/interfaces/AIChatMessageToolCall.md +0 -41
  402. package/docs/interfaces/AIChatToolChoiceFuncObject.md +0 -37
  403. package/docs/interfaces/AIChatToolChoiceObject.md +0 -25
  404. package/docs/interfaces/AIChatToolFunc.md +0 -41
  405. package/docs/interfaces/AIChatToolFuncParam.md +0 -37
  406. package/docs/interfaces/AIChatToolMessageParam.md +0 -113
  407. package/docs/interfaces/AIChatToolParam.md +0 -25
  408. package/docs/interfaces/AIChatToolTypeObject.md +0 -17
  409. package/docs/interfaces/AIChatUserMessageParam.md +0 -137
  410. package/docs/interfaces/AIChoiceConfig.md +0 -65
  411. package/docs/interfaces/AIResult.md +0 -65
  412. package/docs/interfaces/AIStreamParserOptions.md +0 -21
  413. package/docs/interfaces/BaseFunc.md +0 -157
  414. package/docs/interfaces/BaseFuncItem.md +0 -101
  415. package/docs/interfaces/BinarySemaphoreAcquireOptions.md +0 -25
  416. package/docs/interfaces/BinarySemaphoreOptions.md +0 -57
  417. package/docs/interfaces/BinarySemaphoreReleaseOptions.md +0 -25
  418. package/docs/interfaces/BinarySemaphoreReleaserFunc.md +0 -37
  419. package/docs/interfaces/CancelableAbilityOptions.md +0 -113
  420. package/docs/interfaces/ClientFuncItem.md +0 -175
  421. package/docs/interfaces/EventClientFuncParams.md +0 -51
  422. package/docs/interfaces/EventServerFuncParams.md +0 -67
  423. package/docs/interfaces/FuncItem.md +0 -143
  424. package/docs/interfaces/FuncParam.md +0 -61
  425. package/docs/interfaces/FuncParams.md +0 -13
  426. package/docs/interfaces/Funcs.md +0 -13
  427. package/docs/interfaces/HashAlgoParams.md +0 -33
  428. package/docs/interfaces/IFileMetaInfo.md +0 -65
  429. package/docs/interfaces/IReadTextFileChunksOptions.md +0 -143
  430. package/docs/interfaces/ITruncateToTokenLimitOptions.md +0 -99
  431. package/docs/interfaces/JsonFilter.md +0 -13
  432. package/docs/interfaces/ParseObjectArgumentOptions.md +0 -89
  433. package/docs/interfaces/PromptExampleSelectorOptions.md +0 -34
  434. package/docs/interfaces/RemoteFuncItem.md +0 -164
  435. package/docs/interfaces/ReplacePlacehoderOptions.md +0 -41
  436. package/docs/interfaces/ResClientFuncParams.md +0 -37
  437. package/docs/interfaces/ResServerFuncParams.md +0 -69
  438. package/docs/interfaces/SanitizeFilenameOptions.md +0 -25
  439. package/docs/interfaces/SectionStringOptions.md +0 -25
  440. package/docs/interfaces/SemaphoreOptions.md +0 -89
  441. package/docs/interfaces/SemaphoreTaskItem.md +0 -73
  442. package/docs/interfaces/ServerFuncItem.md +0 -183
  443. package/docs/interfaces/ServerFuncParams.md +0 -35
  444. package/docs/interfaces/SplitSentenceOptions.md +0 -41
  445. package/docs/interfaces/ToolFuncPackage.md +0 -47
  446. package/docs/type-aliases/AIModelNameRule.md +0 -11
  447. package/docs/type-aliases/AIModelNameRuleFn.md +0 -21
  448. package/docs/type-aliases/AIModelNameRules.md +0 -11
  449. package/docs/type-aliases/ActionName.md +0 -11
  450. package/docs/type-aliases/AsyncTaskId.md +0 -11
  451. package/docs/type-aliases/FuncParamType.md +0 -11
  452. package/docs/type-aliases/TFunc.md +0 -25
  453. package/docs/variables/ActionNames.md +0 -11
  454. package/docs/variables/ClientToolFuncSchema.md +0 -101
  455. package/docs/variables/EventBusName.md +0 -11
  456. package/docs/variables/EventName.md +0 -11
  457. package/docs/variables/PASSING_SCORE.md +0 -11
  458. package/docs/variables/RStreamErrCode.md +0 -11
  459. package/docs/variables/RemoteToolFuncSchema.md +0 -101
  460. package/docs/variables/ResponseRStreamErrCode.md +0 -11
  461. package/docs/variables/SecondaryCache.md +0 -11
  462. package/docs/variables/ServerToolFuncSchema.md +0 -101
  463. package/docs/variables/ToolAsyncCancelableBit.md +0 -11
  464. package/docs/variables/ToolAsyncMultiTaskBit.md +0 -11
  465. package/docs/variables/ToolAsyncPriorityBit.md +0 -11
  466. package/docs/variables/base32768.md +0 -11
  467. package/docs/variables/event.md +0 -11
  468. package/docs/variables/eventClient.md +0 -11
  469. package/docs/variables/eventServer.md +0 -11
  470. package/docs/variables/lrucache.md +0 -11
  471. /package/docs/{_media → api/_media}/LICENSE-MIT +0 -0
  472. /package/docs/{namespaces → api/namespaces}/EventStates/README.md +0 -0
  473. /package/docs/{namespaces → api/namespaces}/uuidv5/README.md +0 -0
@@ -0,0 +1,3365 @@
1
+ [**@isdk/ai-tool**](../README.md)
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / ResClientTools
6
+
7
+ # Class: ResClientTools
8
+
9
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:9](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/res-client-tools.ts#L9)
10
+
11
+ Represents a client-side proxy for a remote tool function.
12
+
13
+ A `ClientTools` instance is a `ToolFunc` that, when executed, does not run
14
+ local code. Instead, it serializes the parameters and uses an injected
15
+ transport layer (`IClientToolTransport`) to make a remote procedure call
16
+ to its corresponding `ServerTools` counterpart.
17
+
18
+ These tools are typically created dynamically by loading definitions from a server.
19
+
20
+ ## Extends
21
+
22
+ - [`RpcMethodsClientTool`](RpcMethodsClientTool.md)
23
+
24
+ ## Extended by
25
+
26
+ - [`EventClient`](EventClient.md)
27
+
28
+ ## Indexable
29
+
30
+ \[`name`: `string`\]: `any`
31
+
32
+ ## Constructors
33
+
34
+ ### new ResClientTools()
35
+
36
+ > **new ResClientTools**(`name`, `options`?): [`ResClientTools`](ResClientTools.md)
37
+
38
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:571](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L571)
39
+
40
+ The initial value of Object.prototype.constructor is the standard built-in Object constructor.
41
+
42
+ #### Parameters
43
+
44
+ ##### name
45
+
46
+ Can be a function name, a function implementation, or a configuration object.
47
+
48
+ `string` | `Function` | [`FuncItem`](../interfaces/FuncItem.md)
49
+
50
+ ##### options?
51
+
52
+ `any` = `{}`
53
+
54
+ Configuration options if not provided in the first argument.
55
+
56
+ #### Returns
57
+
58
+ [`ResClientTools`](ResClientTools.md)
59
+
60
+ #### Inherited from
61
+
62
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`constructor`](RpcMethodsClientTool.md#constructors)
63
+
64
+ ## Properties
65
+
66
+ ### $attributes
67
+
68
+ > **$attributes**: `Properties`
69
+
70
+ Defined in: [property-manager.js/src/advance.d.ts:5](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/advance.d.ts#L5)
71
+
72
+ #### Inherited from
73
+
74
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`$attributes`](RpcMethodsClientTool.md#$attributes)
75
+
76
+ ***
77
+
78
+ ### action?
79
+
80
+ > `optional` **action**: `"get"` \| `"post"` \| `"put"` \| `"delete"` \| `"patch"` \| `"list"` \| `"res"`
81
+
82
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:95](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/consts.ts#L95)
83
+
84
+ The action to be used for the remote call. This typically represents an RPC method name.
85
+ Only for RESTful HTTP transports, it might be mapped to a standard HTTP method (e.g., GET, POST)
86
+
87
+ #### Inherited from
88
+
89
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`action`](RpcMethodsClientTool.md#action)
90
+
91
+ ***
92
+
93
+ ### alias?
94
+
95
+ > `optional` **alias**: `string` \| `string`[]
96
+
97
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:130](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L130)
98
+
99
+ Optional aliases for the function name.
100
+
101
+ #### Inherited from
102
+
103
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`alias`](RpcMethodsClientTool.md#alias)
104
+
105
+ ***
106
+
107
+ ### asyncFeatures?
108
+
109
+ > `optional` **asyncFeatures**: `number`
110
+
111
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:144](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L144)
112
+
113
+ A bitmask representing asynchronous features supported by the function, built from `AsyncFeatureBits`.
114
+ This allows the system to understand if a function supports capabilities like cancellation or multi-tasking.
115
+
116
+ #### See
117
+
118
+ AsyncFeatureBits from `@src/utils/cancelable-ability.ts`
119
+
120
+ #### Example
121
+
122
+ ```ts
123
+ import { AsyncFeatures } from './utils';
124
+ const func = new ToolFunc({
125
+ name: 'cancellableTask',
126
+ asyncFeatures: AsyncFeatures.Cancelable | AsyncFeatures.MultiTask,
127
+ // ...
128
+ });
129
+ ```
130
+
131
+ #### Inherited from
132
+
133
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`asyncFeatures`](RpcMethodsClientTool.md#asyncfeatures)
134
+
135
+ ***
136
+
137
+ ### constructor
138
+
139
+ > **constructor**: `Function`
140
+
141
+ Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:125
142
+
143
+ The initial value of Object.prototype.constructor is the standard built-in Object constructor.
144
+
145
+ ***
146
+
147
+ ### defaultOptions
148
+
149
+ > **defaultOptions**: `object`
150
+
151
+ Defined in: [property-manager.js/src/abstract.d.ts:74](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L74)
152
+
153
+ The default options for export and assign
154
+
155
+ #### assign?
156
+
157
+ > `optional` **assign**: `IMergeOptions`
158
+
159
+ #### export?
160
+
161
+ > `optional` **export**: `IMergeOptions`
162
+
163
+ #### Inherited from
164
+
165
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`defaultOptions`](RpcMethodsClientTool.md#defaultoptions)
166
+
167
+ ***
168
+
169
+ ### depends?
170
+
171
+ > `optional` **depends**: `object`
172
+
173
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:167](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L167)
174
+
175
+ A map of dependencies this function has on other tool functions.
176
+ Declaring dependencies ensures that they are automatically registered when this function is registered.
177
+ This is crucial for building modular functions that rely on each other without needing to manage registration order manually.
178
+
179
+ #### Index Signature
180
+
181
+ \[`name`: `string`\]: [`ToolFunc`](ToolFunc.md)
182
+
183
+ #### Example
184
+
185
+ ```ts
186
+ const helperFunc = new ToolFunc({ name: 'helper', func: () => 'world' });
187
+ const mainFunc = new ToolFunc({
188
+ name: 'main',
189
+ depends: {
190
+ helper: helperFunc,
191
+ },
192
+ func() {
193
+ // We can now safely run the dependency
194
+ const result = this.runSync('helper');
195
+ return `Hello, ${result}`;
196
+ }
197
+ });
198
+ // When mainFunc is registered, helperFunc will be registered automatically.
199
+ mainFunc.register();
200
+ ```
201
+
202
+ #### Inherited from
203
+
204
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`depends`](RpcMethodsClientTool.md#depends)
205
+
206
+ ***
207
+
208
+ ### description?
209
+
210
+ > `optional` **description**: `string`
211
+
212
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:172](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L172)
213
+
214
+ A detailed description of what the function does.
215
+
216
+ #### Inherited from
217
+
218
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`description`](RpcMethodsClientTool.md#description)
219
+
220
+ ***
221
+
222
+ ### ~~fetchOptions?~~
223
+
224
+ > `optional` **fetchOptions**: `any`
225
+
226
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:101](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/consts.ts#L101)
227
+
228
+ Options to be passed to the underlying `fetch` call in an HTTP transport.
229
+
230
+ #### Deprecated
231
+
232
+ Use `transport` instead.
233
+
234
+ #### Inherited from
235
+
236
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`fetchOptions`](RpcMethodsClientTool.md#fetchoptions)
237
+
238
+ ***
239
+
240
+ ### isApi?
241
+
242
+ > `optional` **isApi**: `boolean`
243
+
244
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:119](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L119)
245
+
246
+ If true, indicates that this function should be treated as a server-side API.
247
+
248
+ #### Inherited from
249
+
250
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`isApi`](RpcMethodsClientTool.md#isapi)
251
+
252
+ ***
253
+
254
+ ### name?
255
+
256
+ > `optional` **name**: `string`
257
+
258
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:76](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L76)
259
+
260
+ The unique name of the function.
261
+
262
+ #### Inherited from
263
+
264
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`name`](RpcMethodsClientTool.md#name-3)
265
+
266
+ ***
267
+
268
+ ### nonExported1stChar
269
+
270
+ > **nonExported1stChar**: `string`
271
+
272
+ Defined in: [property-manager.js/src/abstract.d.ts:78](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L78)
273
+
274
+ the property with the default prefix '$' will not be exported.
275
+
276
+ #### Inherited from
277
+
278
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`nonExported1stChar`](RpcMethodsClientTool.md#nonexported1stchar)
279
+
280
+ ***
281
+
282
+ ### params?
283
+
284
+ > `optional` **params**: [`FuncParams`](../interfaces/FuncParams.md) \| [`FuncParam`](../interfaces/FuncParam.md)[]
285
+
286
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:81](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L81)
287
+
288
+ Parameter definitions, which can be an object mapping names to definitions or an array for positional parameters.
289
+
290
+ #### Inherited from
291
+
292
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`params`](RpcMethodsClientTool.md#params)
293
+
294
+ ***
295
+
296
+ ### result?
297
+
298
+ > `optional` **result**: `string` \| `Record`\<`string`, `any`\>
299
+
300
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:86](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L86)
301
+
302
+ The expected return type of the function, described as a string or a JSON schema object.
303
+
304
+ #### Inherited from
305
+
306
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`result`](RpcMethodsClientTool.md#result)
307
+
308
+ ***
309
+
310
+ ### scope?
311
+
312
+ > `optional` **scope**: `any`
313
+
314
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:91](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L91)
315
+
316
+ The execution scope or context (`this`) for the function.
317
+
318
+ #### Inherited from
319
+
320
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`scope`](RpcMethodsClientTool.md#scope)
321
+
322
+ ***
323
+
324
+ ### setup()?
325
+
326
+ > `optional` **setup**: (`this`, `options`?) => `void`
327
+
328
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:114](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L114)
329
+
330
+ A lifecycle hook called once during the `ToolFunc` instance's initialization.
331
+ It allows for initial setup, state configuration, or property modification on the instance
332
+ before it is used or registered. The `this` context is the `ToolFunc` instance itself.
333
+
334
+ #### Parameters
335
+
336
+ ##### this
337
+
338
+ [`ToolFunc`](ToolFunc.md)
339
+
340
+ ##### options?
341
+
342
+ [`FuncItem`](../interfaces/FuncItem.md)
343
+
344
+ The configuration options for the function.
345
+
346
+ #### Returns
347
+
348
+ `void`
349
+
350
+ #### Example
351
+
352
+ ```ts
353
+ const myFunc = new ToolFunc({
354
+ name: 'myFunc',
355
+ customState: 'initial',
356
+ setup() {
357
+ // `this` is the myFunc instance
358
+ this.customState = 'configured';
359
+ }
360
+ });
361
+ console.log(myFunc.customState); // Outputs: 'configured'
362
+ ```
363
+
364
+ #### Inherited from
365
+
366
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`setup`](RpcMethodsClientTool.md#setup)
367
+
368
+ ***
369
+
370
+ ### stream?
371
+
372
+ > `optional` **stream**: `boolean`
373
+
374
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:125](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L125)
375
+
376
+ If true, indicates that the function has the *capability* to stream its output.
377
+ Whether a specific call is streamed is determined by a `stream` property in the runtime parameters.
378
+
379
+ #### Inherited from
380
+
381
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`stream`](RpcMethodsClientTool.md#stream)
382
+
383
+ ***
384
+
385
+ ### tags?
386
+
387
+ > `optional` **tags**: `string` \| `string`[]
388
+
389
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:96](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L96)
390
+
391
+ Tags for grouping or filtering functions.
392
+
393
+ #### Inherited from
394
+
395
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`tags`](RpcMethodsClientTool.md#tags)
396
+
397
+ ***
398
+
399
+ ### title?
400
+
401
+ > `optional` **title**: `string`
402
+
403
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:177](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L177)
404
+
405
+ A concise, human-readable title for the function, often used in UI or by AI.
406
+
407
+ #### Inherited from
408
+
409
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`title`](RpcMethodsClientTool.md#title)
410
+
411
+ ***
412
+
413
+ ### action?
414
+
415
+ > `static` `optional` **action**: `string`
416
+
417
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:32](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/client-tools.ts#L32)
418
+
419
+ #### Inherited from
420
+
421
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`action`](RpcMethodsClientTool.md#action-1)
422
+
423
+ ***
424
+
425
+ ### aliases
426
+
427
+ > `static` **aliases**: `object` = `{}`
428
+
429
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:305](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L305)
430
+
431
+ A static map of aliases to their corresponding function names.
432
+
433
+ #### Index Signature
434
+
435
+ \[`name`: `string`\]: `string`
436
+
437
+ #### Inherited from
438
+
439
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`aliases`](RpcMethodsClientTool.md#aliases)
440
+
441
+ ***
442
+
443
+ ### dataPath
444
+
445
+ > `static` **dataPath**: `string`
446
+
447
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:312](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L312)
448
+
449
+ A conventional property to designate a file path for saving the registered `ToolFunc` data.
450
+ Note: The `ToolFunc` class itself does not implement persistence logic. It is up to the
451
+ developer to use this path to save and load the `ToolFunc.items` registry if needed.
452
+
453
+ #### Inherited from
454
+
455
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`dataPath`](RpcMethodsClientTool.md#datapath)
456
+
457
+ ***
458
+
459
+ ### items
460
+
461
+ > `static` **items**: [`Funcs`](../interfaces/Funcs.md) = `{}`
462
+
463
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:300](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L300)
464
+
465
+ A static registry of all `ToolFunc` instances, indexed by name.
466
+
467
+ #### Inherited from
468
+
469
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`items`](RpcMethodsClientTool.md#items)
470
+
471
+ ## Accessors
472
+
473
+ ### ~~apiRoot~~
474
+
475
+ #### Get Signature
476
+
477
+ > **get** **apiRoot**(): `string`
478
+
479
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:109](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/client-tools.ts#L109)
480
+
481
+ ##### Deprecated
482
+
483
+ This property is now mainly for informational purposes.
484
+ The actual endpoint is managed by the transport.
485
+
486
+ ##### Returns
487
+
488
+ `string`
489
+
490
+ The root endpoint for the remote service.
491
+
492
+ #### Deprecated
493
+
494
+ Use `transport` instead.
495
+
496
+ #### Inherited from
497
+
498
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`apiRoot`](RpcMethodsClientTool.md#apiroot)
499
+
500
+ ***
501
+
502
+ ### apiRoot
503
+
504
+ #### Get Signature
505
+
506
+ > **get** `static` **apiRoot**(): `string`
507
+
508
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:40](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/client-tools.ts#L40)
509
+
510
+ ##### Deprecated
511
+
512
+ This property is now mainly for informational purposes.
513
+ The actual endpoint is managed by the transport.
514
+
515
+ ##### Returns
516
+
517
+ `string`
518
+
519
+ #### Inherited from
520
+
521
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`apiRoot`](RpcMethodsClientTool.md#apiroot-2)
522
+
523
+ ***
524
+
525
+ ### transport
526
+
527
+ #### Get Signature
528
+
529
+ > **get** `static` **transport**(): [`IClientToolTransport`](../interfaces/IClientToolTransport.md)
530
+
531
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:60](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/client-tools.ts#L60)
532
+
533
+ ##### Returns
534
+
535
+ [`IClientToolTransport`](../interfaces/IClientToolTransport.md)
536
+
537
+ #### Inherited from
538
+
539
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`transport`](RpcMethodsClientTool.md#transport)
540
+
541
+ ## Methods
542
+
543
+ ### \_func()
544
+
545
+ > **\_func**(`action`, `options`): `Promise`\<`any`\>
546
+
547
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-client-tool.ts:19](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/rpc-methods-client-tool.ts#L19)
548
+
549
+ #### Parameters
550
+
551
+ ##### action
552
+
553
+ `"get"` | `"post"` | `"put"` | `"delete"` | `"patch"` | `"list"` | `"res"`
554
+
555
+ ##### options
556
+
557
+ [`RpcMethodsClientFuncParams`](../interfaces/RpcMethodsClientFuncParams.md)
558
+
559
+ #### Returns
560
+
561
+ `Promise`\<`any`\>
562
+
563
+ #### Inherited from
564
+
565
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`_func`](RpcMethodsClientTool.md#_func)
566
+
567
+ ***
568
+
569
+ ### arr2ObjParams()
570
+
571
+ > **arr2ObjParams**(`params`): `any`[]
572
+
573
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:629](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L629)
574
+
575
+ Converts an array of positional arguments into a named parameters object.
576
+ This is used internally to support functions defined with named parameters.
577
+
578
+ #### Parameters
579
+
580
+ ##### params
581
+
582
+ `any`[]
583
+
584
+ An array of positional arguments.
585
+
586
+ #### Returns
587
+
588
+ `any`[]
589
+
590
+ An array containing a single parameters object.
591
+
592
+ #### Inherited from
593
+
594
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`arr2ObjParams`](RpcMethodsClientTool.md#arr2objparams)
595
+
596
+ ***
597
+
598
+ ### assign()
599
+
600
+ > **assign**(`src`, `options`?): `this`
601
+
602
+ Defined in: [property-manager.js/src/abstract.d.ts:106](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L106)
603
+
604
+ Assign the values from the src object.
605
+
606
+ #### Parameters
607
+
608
+ ##### src
609
+
610
+ `any`
611
+
612
+ the source object
613
+
614
+ ##### options?
615
+
616
+ `IMergeOptions`
617
+
618
+ #### Returns
619
+
620
+ `this`
621
+
622
+ this object
623
+
624
+ #### Inherited from
625
+
626
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`assign`](RpcMethodsClientTool.md#assign)
627
+
628
+ ***
629
+
630
+ ### assignMethods()
631
+
632
+ > **assignMethods**(`methods`): `void`
633
+
634
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-client-tool.ts:32](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/rpc-methods-client-tool.ts#L32)
635
+
636
+ #### Parameters
637
+
638
+ ##### methods
639
+
640
+ `string`[]
641
+
642
+ #### Returns
643
+
644
+ `void`
645
+
646
+ #### Inherited from
647
+
648
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`assignMethods`](RpcMethodsClientTool.md#assignmethods)
649
+
650
+ ***
651
+
652
+ ### assignProperty()
653
+
654
+ > **assignProperty**(`src`, `name`, `value`, `attrs`?, `options`?): `void`
655
+
656
+ Defined in: [property-manager.js/src/abstract.d.ts:117](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L117)
657
+
658
+ Assign a property of src to this object.
659
+
660
+ #### Parameters
661
+
662
+ ##### src
663
+
664
+ `any`
665
+
666
+ the src object
667
+
668
+ ##### name
669
+
670
+ `string`
671
+
672
+ the property name to assign
673
+
674
+ ##### value
675
+
676
+ `any`
677
+
678
+ the property value to assign
679
+
680
+ ##### attrs?
681
+
682
+ `any`
683
+
684
+ the attributes object
685
+
686
+ ##### options?
687
+
688
+ `IMergeOptions`
689
+
690
+ #### Returns
691
+
692
+ `void`
693
+
694
+ #### Inherited from
695
+
696
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`assignProperty`](RpcMethodsClientTool.md#assignproperty)
697
+
698
+ ***
699
+
700
+ ### assignPropertyTo()
701
+
702
+ > `abstract` **assignPropertyTo**(`dest`, `src`, `name`, `value`, `attrs`?, `options`?): `void`
703
+
704
+ Defined in: [property-manager.js/src/abstract.d.ts:131](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L131)
705
+
706
+ Assign the property value from the src to destination object.
707
+
708
+ #### Parameters
709
+
710
+ ##### dest
711
+
712
+ `any`
713
+
714
+ The destination object
715
+
716
+ ##### src
717
+
718
+ `any`
719
+
720
+ The src object
721
+
722
+ ##### name
723
+
724
+ `string`
725
+
726
+ The property name
727
+
728
+ ##### value
729
+
730
+ `any`
731
+
732
+ The property value
733
+
734
+ ##### attrs?
735
+
736
+ `any`
737
+
738
+ The attributes object of the property
739
+
740
+ ##### options?
741
+
742
+ `IMergeOptions`
743
+
744
+ #### Returns
745
+
746
+ `void`
747
+
748
+ #### Inherited from
749
+
750
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`assignPropertyTo`](RpcMethodsClientTool.md#assignpropertyto)
751
+
752
+ ***
753
+
754
+ ### assignTo()
755
+
756
+ > **assignTo**(`dest`?, `options`?): `any`
757
+
758
+ Defined in: [property-manager.js/src/abstract.d.ts:191](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L191)
759
+
760
+ Assign this attributes to the dest object
761
+
762
+ #### Parameters
763
+
764
+ ##### dest?
765
+
766
+ `any`
767
+
768
+ the destination object
769
+
770
+ ##### options?
771
+
772
+ `IMergeOptions`
773
+
774
+ #### Returns
775
+
776
+ `any`
777
+
778
+ the dest object
779
+
780
+ #### Inherited from
781
+
782
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`assignTo`](RpcMethodsClientTool.md#assignto)
783
+
784
+ ***
785
+
786
+ ### clone()
787
+
788
+ > **clone**(`options`?): `any`
789
+
790
+ Defined in: [property-manager.js/src/abstract.d.ts:155](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L155)
791
+
792
+ Create a new object with the same values of attributes.
793
+
794
+ #### Parameters
795
+
796
+ ##### options?
797
+
798
+ `IMergeOptions`
799
+
800
+ #### Returns
801
+
802
+ `any`
803
+
804
+ the new object
805
+
806
+ #### Inherited from
807
+
808
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`clone`](RpcMethodsClientTool.md#clone)
809
+
810
+ ***
811
+
812
+ ### cloneTo()
813
+
814
+ > **cloneTo**(`dest`, `options`?): `any`
815
+
816
+ Defined in: [property-manager.js/src/abstract.d.ts:148](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L148)
817
+
818
+ Create and assign the values to the destination object.
819
+
820
+ #### Parameters
821
+
822
+ ##### dest
823
+
824
+ `any`
825
+
826
+ the destination object
827
+
828
+ ##### options?
829
+
830
+ `IMergeOptions`
831
+
832
+ #### Returns
833
+
834
+ `any`
835
+
836
+ the new dest object
837
+
838
+ #### Inherited from
839
+
840
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`cloneTo`](RpcMethodsClientTool.md#cloneto)
841
+
842
+ ***
843
+
844
+ ### defineProperties()
845
+
846
+ > `abstract` **defineProperties**(`aProperties`): `any`
847
+
848
+ Defined in: [property-manager.js/src/abstract.d.ts:89](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L89)
849
+
850
+ Define the attributes of this object.
851
+
852
+ #### Parameters
853
+
854
+ ##### aProperties
855
+
856
+ `SimplePropDescriptors`
857
+
858
+ the defined attributes of the object
859
+
860
+ #### Returns
861
+
862
+ `any`
863
+
864
+ #### Inherited from
865
+
866
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`defineProperties`](RpcMethodsClientTool.md#defineproperties)
867
+
868
+ ***
869
+
870
+ ### delete()?
871
+
872
+ > `optional` **delete**(`__namedParameters`): `any`
873
+
874
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:13](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/res-client-tools.ts#L13)
875
+
876
+ #### Parameters
877
+
878
+ ##### \_\_namedParameters
879
+
880
+ [`ResClientFuncParams`](../interfaces/ResClientFuncParams.md)
881
+
882
+ #### Returns
883
+
884
+ `any`
885
+
886
+ ***
887
+
888
+ ### exportTo()
889
+
890
+ > **exportTo**(`dest`, `options`?): `any`
891
+
892
+ Defined in: [property-manager.js/src/abstract.d.ts:173](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L173)
893
+
894
+ Export attributes to the dest json object.
895
+
896
+ #### Parameters
897
+
898
+ ##### dest
899
+
900
+ `any`
901
+
902
+ the destination object
903
+
904
+ ##### options?
905
+
906
+ `IExportOptions`
907
+
908
+ #### Returns
909
+
910
+ `any`
911
+
912
+ the dest object.
913
+
914
+ #### Inherited from
915
+
916
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`exportTo`](RpcMethodsClientTool.md#exportto)
917
+
918
+ ***
919
+
920
+ ### fetch()
921
+
922
+ > **fetch**(`options`, `action`): `Promise`\<`any`\>
923
+
924
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:18](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/res-client-tools.ts#L18)
925
+
926
+ #### Parameters
927
+
928
+ ##### options
929
+
930
+ [`ResClientFuncParams`](../interfaces/ResClientFuncParams.md)
931
+
932
+ ##### action
933
+
934
+ `"get"` | `"post"` | `"put"` | `"delete"` | `"patch"` | `"list"` | `"res"`
935
+
936
+ #### Returns
937
+
938
+ `Promise`\<`any`\>
939
+
940
+ #### Inherited from
941
+
942
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`fetch`](RpcMethodsClientTool.md#fetch)
943
+
944
+ ***
945
+
946
+ ### func()
947
+
948
+ > **func**(`options`): `Promise`\<`any`\>
949
+
950
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-client-tool.ts:24](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/rpc-methods-client-tool.ts#L24)
951
+
952
+ The core implementation for a client-side tool. When a `ClientTools` instance
953
+ is "run", this `func` method is executed. It delegates the call to the
954
+ configured transport, which handles the network communication.
955
+
956
+ #### Parameters
957
+
958
+ ##### options
959
+
960
+ [`RpcMethodsClientFuncParams`](../interfaces/RpcMethodsClientFuncParams.md)
961
+
962
+ #### Returns
963
+
964
+ `Promise`\<`any`\>
965
+
966
+ The result from the remote tool.
967
+
968
+ #### Inherited from
969
+
970
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`func`](RpcMethodsClientTool.md#func)
971
+
972
+ ***
973
+
974
+ ### get()?
975
+
976
+ > `optional` **get**(`__namedParameters`): `any`
977
+
978
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/res-client-tools.ts#L10)
979
+
980
+ #### Parameters
981
+
982
+ ##### \_\_namedParameters
983
+
984
+ [`ResClientFuncParams`](../interfaces/ResClientFuncParams.md)
985
+
986
+ #### Returns
987
+
988
+ `any`
989
+
990
+ ***
991
+
992
+ ### getFunc()
993
+
994
+ > **getFunc**(`name`?): `any`
995
+
996
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:720](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L720)
997
+
998
+ Gets a bound function reference for execution with named parameters.
999
+ If a name is provided, it retrieves a different function from the registry.
1000
+ Otherwise, it returns a bound version of this instance's `runSync`.
1001
+
1002
+ #### Parameters
1003
+
1004
+ ##### name?
1005
+
1006
+ `string`
1007
+
1008
+ Optional name of the function to retrieve.
1009
+
1010
+ #### Returns
1011
+
1012
+ `any`
1013
+
1014
+ A function reference or `undefined` if not found.
1015
+
1016
+ #### Inherited from
1017
+
1018
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`getFunc`](RpcMethodsClientTool.md#getfunc)
1019
+
1020
+ ***
1021
+
1022
+ ### getFuncWithPos()
1023
+
1024
+ > **getFuncWithPos**(`name`?): `any`
1025
+
1026
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:777](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L777)
1027
+
1028
+ Gets a bound function reference suitable for positional argument execution.
1029
+ If a name is provided, it retrieves a different function from the registry.
1030
+ Otherwise, it returns a bound version of this instance's `runWithPosSync`.
1031
+
1032
+ #### Parameters
1033
+
1034
+ ##### name?
1035
+
1036
+ `string`
1037
+
1038
+ Optional name of the function to retrieve.
1039
+
1040
+ #### Returns
1041
+
1042
+ `any`
1043
+
1044
+ A function reference or `undefined` if not found.
1045
+
1046
+ #### Inherited from
1047
+
1048
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`getFuncWithPos`](RpcMethodsClientTool.md#getfuncwithpos)
1049
+
1050
+ ***
1051
+
1052
+ ### getProperties()
1053
+
1054
+ > `abstract` **getProperties**(): `PropDescriptors`
1055
+
1056
+ Defined in: [property-manager.js/src/abstract.d.ts:98](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L98)
1057
+
1058
+ Get the defined attributes.
1059
+
1060
+ #### Returns
1061
+
1062
+ `PropDescriptors`
1063
+
1064
+ the descriptors of properties object
1065
+
1066
+ #### Inherited from
1067
+
1068
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`getProperties`](RpcMethodsClientTool.md#getproperties)
1069
+
1070
+ ***
1071
+
1072
+ ### hasAsyncFeature()
1073
+
1074
+ > **hasAsyncFeature**(`feature`): `boolean`
1075
+
1076
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:787](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L787)
1077
+
1078
+ Checks if the current function instance supports a specific async feature.
1079
+
1080
+ #### Parameters
1081
+
1082
+ ##### feature
1083
+
1084
+ [`AsyncFeatureBits`](../enumerations/AsyncFeatureBits.md)
1085
+
1086
+ The async feature bit to check for.
1087
+
1088
+ #### Returns
1089
+
1090
+ `boolean`
1091
+
1092
+ `true` if the feature is supported, otherwise `false`.
1093
+
1094
+ #### Inherited from
1095
+
1096
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`hasAsyncFeature`](RpcMethodsClientTool.md#hasasyncfeature)
1097
+
1098
+ ***
1099
+
1100
+ ### hasOwnProperty()
1101
+
1102
+ > **hasOwnProperty**(`v`): `boolean`
1103
+
1104
+ Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:140
1105
+
1106
+ Determines whether an object has a property with the specified name.
1107
+
1108
+ #### Parameters
1109
+
1110
+ ##### v
1111
+
1112
+ `PropertyKey`
1113
+
1114
+ A property name.
1115
+
1116
+ #### Returns
1117
+
1118
+ `boolean`
1119
+
1120
+ #### Inherited from
1121
+
1122
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`hasOwnProperty`](RpcMethodsClientTool.md#hasownproperty)
1123
+
1124
+ ***
1125
+
1126
+ ### initialize()
1127
+
1128
+ > **initialize**(`src`?): `this`
1129
+
1130
+ Defined in: [property-manager.js/src/abstract.d.ts:139](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L139)
1131
+
1132
+ Initialize object and assign attribute values from src if src exists.
1133
+
1134
+ #### Parameters
1135
+
1136
+ ##### src?
1137
+
1138
+ `any`
1139
+
1140
+ #### Returns
1141
+
1142
+ `this`
1143
+
1144
+ this object.
1145
+
1146
+ #### Inherited from
1147
+
1148
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`initialize`](RpcMethodsClientTool.md#initialize)
1149
+
1150
+ ***
1151
+
1152
+ ### isPrototypeOf()
1153
+
1154
+ > **isPrototypeOf**(`v`): `boolean`
1155
+
1156
+ Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:146
1157
+
1158
+ Determines whether an object exists in another object's prototype chain.
1159
+
1160
+ #### Parameters
1161
+
1162
+ ##### v
1163
+
1164
+ `Object`
1165
+
1166
+ Another object whose prototype chain is to be checked.
1167
+
1168
+ #### Returns
1169
+
1170
+ `boolean`
1171
+
1172
+ #### Inherited from
1173
+
1174
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`isPrototypeOf`](RpcMethodsClientTool.md#isprototypeof)
1175
+
1176
+ ***
1177
+
1178
+ ### isSame()
1179
+
1180
+ > **isSame**(`src`, `options`?): `boolean`
1181
+
1182
+ Defined in: [property-manager.js/src/abstract.d.ts:200](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L200)
1183
+
1184
+ Check the src object whether “equals” this object.
1185
+
1186
+ #### Parameters
1187
+
1188
+ ##### src
1189
+
1190
+ `any`
1191
+
1192
+ The source object
1193
+
1194
+ ##### options?
1195
+
1196
+ `IMergeOptions`
1197
+
1198
+ #### Returns
1199
+
1200
+ `boolean`
1201
+
1202
+ #### Inherited from
1203
+
1204
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`isSame`](RpcMethodsClientTool.md#issame)
1205
+
1206
+ ***
1207
+
1208
+ ### isStream()
1209
+
1210
+ > **isStream**(`params`): `undefined` \| `boolean`
1211
+
1212
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:805](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L805)
1213
+
1214
+ Determines if a function call should produce a stream.
1215
+
1216
+ The logic is as follows:
1217
+ 1. It first checks if the function is generally capable of streaming (`this.stream`).
1218
+ 2. If it is, it then checks if a `stream` parameter is formally declared in the function's `params` definition.
1219
+ 3. If both are true, the method returns the value of the `stream` property from the runtime `params` object.
1220
+ Otherwise, it returns the function's static `stream` capability.
1221
+
1222
+ #### Parameters
1223
+
1224
+ ##### params
1225
+
1226
+ `any`
1227
+
1228
+ The runtime parameters passed to the function call.
1229
+
1230
+ #### Returns
1231
+
1232
+ `undefined` \| `boolean`
1233
+
1234
+ `true` if the call should be streamed, `false` or `undefined` otherwise.
1235
+
1236
+ #### Inherited from
1237
+
1238
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`isStream`](RpcMethodsClientTool.md#isstream)
1239
+
1240
+ ***
1241
+
1242
+ ### list()?
1243
+
1244
+ > `optional` **list**(`options`?): `any`
1245
+
1246
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:14](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/res-client-tools.ts#L14)
1247
+
1248
+ #### Parameters
1249
+
1250
+ ##### options?
1251
+
1252
+ [`ResClientFuncParams`](../interfaces/ResClientFuncParams.md)
1253
+
1254
+ #### Returns
1255
+
1256
+ `any`
1257
+
1258
+ ***
1259
+
1260
+ ### mergeTo()
1261
+
1262
+ > **mergeTo**(`dest`, `options`?): `any`
1263
+
1264
+ Defined in: [property-manager.js/src/abstract.d.ts:164](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L164)
1265
+
1266
+ Merge this attributes to dest object.
1267
+
1268
+ #### Parameters
1269
+
1270
+ ##### dest
1271
+
1272
+ `any`
1273
+
1274
+ The destination object
1275
+
1276
+ ##### options?
1277
+
1278
+ `IMergeOptions`
1279
+
1280
+ #### Returns
1281
+
1282
+ `any`
1283
+
1284
+ the dest object.
1285
+
1286
+ #### Inherited from
1287
+
1288
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`mergeTo`](RpcMethodsClientTool.md#mergeto)
1289
+
1290
+ ***
1291
+
1292
+ ### obj2ArrParams()
1293
+
1294
+ > **obj2ArrParams**(`params`?): `any`[]
1295
+
1296
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:648](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L648)
1297
+
1298
+ Converts a named parameters object into an array of positional arguments.
1299
+ This is used for functions defined with positional parameters.
1300
+
1301
+ #### Parameters
1302
+
1303
+ ##### params?
1304
+
1305
+ `any`
1306
+
1307
+ A named parameters object.
1308
+
1309
+ #### Returns
1310
+
1311
+ `any`[]
1312
+
1313
+ An array of positional arguments.
1314
+
1315
+ #### Inherited from
1316
+
1317
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`obj2ArrParams`](RpcMethodsClientTool.md#obj2arrparams)
1318
+
1319
+ ***
1320
+
1321
+ ### post()?
1322
+
1323
+ > `optional` **post**(`options`): `any`
1324
+
1325
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:11](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/res-client-tools.ts#L11)
1326
+
1327
+ #### Parameters
1328
+
1329
+ ##### options
1330
+
1331
+ [`ResClientFuncParams`](../interfaces/ResClientFuncParams.md)
1332
+
1333
+ #### Returns
1334
+
1335
+ `any`
1336
+
1337
+ ***
1338
+
1339
+ ### propertyIsEnumerable()
1340
+
1341
+ > **propertyIsEnumerable**(`v`): `boolean`
1342
+
1343
+ Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:152
1344
+
1345
+ Determines whether a specified property is enumerable.
1346
+
1347
+ #### Parameters
1348
+
1349
+ ##### v
1350
+
1351
+ `PropertyKey`
1352
+
1353
+ A property name.
1354
+
1355
+ #### Returns
1356
+
1357
+ `boolean`
1358
+
1359
+ #### Inherited from
1360
+
1361
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`propertyIsEnumerable`](RpcMethodsClientTool.md#propertyisenumerable)
1362
+
1363
+ ***
1364
+
1365
+ ### put()?
1366
+
1367
+ > `optional` **put**(`__namedParameters`): `any`
1368
+
1369
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:12](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/res-client-tools.ts#L12)
1370
+
1371
+ #### Parameters
1372
+
1373
+ ##### \_\_namedParameters
1374
+
1375
+ [`ResClientFuncParams`](../interfaces/ResClientFuncParams.md)
1376
+
1377
+ #### Returns
1378
+
1379
+ `any`
1380
+
1381
+ ***
1382
+
1383
+ ### register()
1384
+
1385
+ > **register**(): `boolean` \| [`ToolFunc`](ToolFunc.md)
1386
+
1387
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:602](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L602)
1388
+
1389
+ Registers the current `ToolFunc` instance into the static registry.
1390
+ Also registers any declared dependencies.
1391
+
1392
+ #### Returns
1393
+
1394
+ `boolean` \| [`ToolFunc`](ToolFunc.md)
1395
+
1396
+ The instance itself upon successful registration, or `false` if it already exists.
1397
+
1398
+ #### Inherited from
1399
+
1400
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`register`](RpcMethodsClientTool.md#register)
1401
+
1402
+ ***
1403
+
1404
+ ### run()
1405
+
1406
+ > **run**(`params`?): `Promise`\<`any`\>
1407
+
1408
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:686](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L686)
1409
+
1410
+ Executes the function asynchronously with a named parameters object.
1411
+
1412
+ #### Parameters
1413
+
1414
+ ##### params?
1415
+
1416
+ `any`
1417
+
1418
+ The parameters object for the function.
1419
+
1420
+ #### Returns
1421
+
1422
+ `Promise`\<`any`\>
1423
+
1424
+ A promise that resolves with the function's result.
1425
+
1426
+ #### Inherited from
1427
+
1428
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`run`](RpcMethodsClientTool.md#run)
1429
+
1430
+ ***
1431
+
1432
+ ### runAs()
1433
+
1434
+ > **runAs**(`name`, `params`?): `Promise`\<`any`\>
1435
+
1436
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:697](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L697)
1437
+
1438
+ Asynchronously executes another registered function by name.
1439
+ This method delegates to `runAsSync()` internally.
1440
+
1441
+ #### Parameters
1442
+
1443
+ ##### name
1444
+
1445
+ `string`
1446
+
1447
+ The name of the target function to run.
1448
+
1449
+ ##### params?
1450
+
1451
+ `any`
1452
+
1453
+ Optional parameters to pass to the function.
1454
+
1455
+ #### Returns
1456
+
1457
+ `Promise`\<`any`\>
1458
+
1459
+ A promise that resolves with the result of the function execution.
1460
+
1461
+ #### Inherited from
1462
+
1463
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`runAs`](RpcMethodsClientTool.md#runas)
1464
+
1465
+ ***
1466
+
1467
+ ### runAsSync()
1468
+
1469
+ > **runAsSync**(`name`, `params`?): `any`
1470
+
1471
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:708](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L708)
1472
+
1473
+ Synchronously executes another registered function by name.
1474
+ This is a convenience method that forwards the call to the static `runSync()` method.
1475
+
1476
+ #### Parameters
1477
+
1478
+ ##### name
1479
+
1480
+ `string`
1481
+
1482
+ The name of the target function to run.
1483
+
1484
+ ##### params?
1485
+
1486
+ `any`
1487
+
1488
+ Optional parameters to pass to the function.
1489
+
1490
+ #### Returns
1491
+
1492
+ `any`
1493
+
1494
+ The result of the function execution.
1495
+
1496
+ #### Inherited from
1497
+
1498
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`runAsSync`](RpcMethodsClientTool.md#runassync)
1499
+
1500
+ ***
1501
+
1502
+ ### runSync()
1503
+
1504
+ > **runSync**(`params`?): `any`
1505
+
1506
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:667](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L667)
1507
+
1508
+ Executes the function synchronously with a named parameters object.
1509
+
1510
+ #### Parameters
1511
+
1512
+ ##### params?
1513
+
1514
+ `any`
1515
+
1516
+ The parameters object for the function.
1517
+
1518
+ #### Returns
1519
+
1520
+ `any`
1521
+
1522
+ The result of the function execution.
1523
+
1524
+ #### Throws
1525
+
1526
+ Will throw an error if an array of parameters is passed to a function that expects an object.
1527
+
1528
+ #### Inherited from
1529
+
1530
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`runSync`](RpcMethodsClientTool.md#runsync)
1531
+
1532
+ ***
1533
+
1534
+ ### runWithPos()
1535
+
1536
+ > **runWithPos**(...`params`): `Promise`\<`any`\>
1537
+
1538
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:755](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L755)
1539
+
1540
+ Executes the function asynchronously using positional arguments.
1541
+ Delegates to `runWithPosSync()` internally.
1542
+
1543
+ #### Parameters
1544
+
1545
+ ##### params
1546
+
1547
+ ...`any`[]
1548
+
1549
+ Positional arguments passed to the function.
1550
+
1551
+ #### Returns
1552
+
1553
+ `Promise`\<`any`\>
1554
+
1555
+ A promise that resolves with the result of the function execution.
1556
+
1557
+ #### Inherited from
1558
+
1559
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`runWithPos`](RpcMethodsClientTool.md#runwithpos)
1560
+
1561
+ ***
1562
+
1563
+ ### runWithPosAs()
1564
+
1565
+ > **runWithPosAs**(`name`, ...`params`): `Promise`\<`any`\>
1566
+
1567
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:766](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L766)
1568
+
1569
+ Asynchronously executes another function by name using positional arguments.
1570
+ Delegates to `runWithPosAsSync()` internally.
1571
+
1572
+ #### Parameters
1573
+
1574
+ ##### name
1575
+
1576
+ `string`
1577
+
1578
+ The name of the target function to run.
1579
+
1580
+ ##### params
1581
+
1582
+ ...`any`[]
1583
+
1584
+ Positional arguments to pass to the function.
1585
+
1586
+ #### Returns
1587
+
1588
+ `Promise`\<`any`\>
1589
+
1590
+ A promise that resolves with the result of the function execution.
1591
+
1592
+ #### Inherited from
1593
+
1594
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`runWithPosAs`](RpcMethodsClientTool.md#runwithposas)
1595
+
1596
+ ***
1597
+
1598
+ ### runWithPosAsSync()
1599
+
1600
+ > **runWithPosAsSync**(`name`, ...`params`): `any`
1601
+
1602
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:745](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L745)
1603
+
1604
+ Synchronously executes another function by name using positional arguments.
1605
+ This is a convenience wrapper around the static `runWithPosSync()` method.
1606
+
1607
+ #### Parameters
1608
+
1609
+ ##### name
1610
+
1611
+ `string`
1612
+
1613
+ The name of the target function to run.
1614
+
1615
+ ##### params
1616
+
1617
+ ...`any`[]
1618
+
1619
+ Positional arguments to pass to the function.
1620
+
1621
+ #### Returns
1622
+
1623
+ `any`
1624
+
1625
+ The result of the function execution.
1626
+
1627
+ #### Inherited from
1628
+
1629
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`runWithPosAsSync`](RpcMethodsClientTool.md#runwithposassync)
1630
+
1631
+ ***
1632
+
1633
+ ### runWithPosSync()
1634
+
1635
+ > **runWithPosSync**(...`params`): `any`
1636
+
1637
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:731](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L731)
1638
+
1639
+ Executes the function synchronously using positional arguments.
1640
+ If the function expects named parameters, it converts the arguments automatically.
1641
+
1642
+ #### Parameters
1643
+
1644
+ ##### params
1645
+
1646
+ ...`any`[]
1647
+
1648
+ Positional arguments passed to the function.
1649
+
1650
+ #### Returns
1651
+
1652
+ `any`
1653
+
1654
+ The result of the function execution.
1655
+
1656
+ #### Inherited from
1657
+
1658
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`runWithPosSync`](RpcMethodsClientTool.md#runwithpossync)
1659
+
1660
+ ***
1661
+
1662
+ ### toJSON()
1663
+
1664
+ > **toJSON**(): `any`
1665
+
1666
+ Defined in: [property-manager.js/src/abstract.d.ts:182](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L182)
1667
+
1668
+ #### Returns
1669
+
1670
+ `any`
1671
+
1672
+ #### Inherited from
1673
+
1674
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`toJSON`](RpcMethodsClientTool.md#tojson)
1675
+
1676
+ ***
1677
+
1678
+ ### toLocaleString()
1679
+
1680
+ > **toLocaleString**(): `string`
1681
+
1682
+ Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:131
1683
+
1684
+ Returns a date converted to a string using the current locale.
1685
+
1686
+ #### Returns
1687
+
1688
+ `string`
1689
+
1690
+ #### Inherited from
1691
+
1692
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`toLocaleString`](RpcMethodsClientTool.md#tolocalestring)
1693
+
1694
+ ***
1695
+
1696
+ ### toObject()
1697
+
1698
+ > **toObject**(`options`?): `any`
1699
+
1700
+ Defined in: [property-manager.js/src/abstract.d.ts:181](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L181)
1701
+
1702
+ Convert the attributes to the json object
1703
+
1704
+ #### Parameters
1705
+
1706
+ ##### options?
1707
+
1708
+ `any`
1709
+
1710
+ #### Returns
1711
+
1712
+ `any`
1713
+
1714
+ the json object.
1715
+
1716
+ #### Inherited from
1717
+
1718
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`toObject`](RpcMethodsClientTool.md#toobject)
1719
+
1720
+ ***
1721
+
1722
+ ### toString()
1723
+
1724
+ > **toString**(): `string`
1725
+
1726
+ Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:128
1727
+
1728
+ Returns a string representation of an object.
1729
+
1730
+ #### Returns
1731
+
1732
+ `string`
1733
+
1734
+ #### Inherited from
1735
+
1736
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`toString`](RpcMethodsClientTool.md#tostring)
1737
+
1738
+ ***
1739
+
1740
+ ### unregister()
1741
+
1742
+ > **unregister**(): `any`
1743
+
1744
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:619](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L619)
1745
+
1746
+ Removes the current `ToolFunc` instance from the static registry.
1747
+
1748
+ #### Returns
1749
+
1750
+ `any`
1751
+
1752
+ The instance that was unregistered.
1753
+
1754
+ #### Inherited from
1755
+
1756
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`unregister`](RpcMethodsClientTool.md#unregister)
1757
+
1758
+ ***
1759
+
1760
+ ### valueOf()
1761
+
1762
+ > **valueOf**(): `Object`
1763
+
1764
+ Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:134
1765
+
1766
+ Returns the primitive value of the specified object.
1767
+
1768
+ #### Returns
1769
+
1770
+ `Object`
1771
+
1772
+ #### Inherited from
1773
+
1774
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`valueOf`](RpcMethodsClientTool.md#valueof)
1775
+
1776
+ ***
1777
+
1778
+ ### assign()
1779
+
1780
+ #### Call Signature
1781
+
1782
+ > `static` **assign**\<`T`, `U`\>(`target`, `source`): `T` & `U`
1783
+
1784
+ Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:286
1785
+
1786
+ Copy the values of all of the enumerable own properties from one or more source objects to a
1787
+ target object. Returns the target object.
1788
+
1789
+ ##### Type Parameters
1790
+
1791
+ • **T** *extends* `object`
1792
+
1793
+ • **U**
1794
+
1795
+ ##### Parameters
1796
+
1797
+ ###### target
1798
+
1799
+ `T`
1800
+
1801
+ The target object to copy to.
1802
+
1803
+ ###### source
1804
+
1805
+ `U`
1806
+
1807
+ The source object from which to copy properties.
1808
+
1809
+ ##### Returns
1810
+
1811
+ `T` & `U`
1812
+
1813
+ ##### Inherited from
1814
+
1815
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`assign`](RpcMethodsClientTool.md#assign-2)
1816
+
1817
+ #### Call Signature
1818
+
1819
+ > `static` **assign**\<`T`, `U`, `V`\>(`target`, `source1`, `source2`): `T` & `U` & `V`
1820
+
1821
+ Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:295
1822
+
1823
+ Copy the values of all of the enumerable own properties from one or more source objects to a
1824
+ target object. Returns the target object.
1825
+
1826
+ ##### Type Parameters
1827
+
1828
+ • **T** *extends* `object`
1829
+
1830
+ • **U**
1831
+
1832
+ • **V**
1833
+
1834
+ ##### Parameters
1835
+
1836
+ ###### target
1837
+
1838
+ `T`
1839
+
1840
+ The target object to copy to.
1841
+
1842
+ ###### source1
1843
+
1844
+ `U`
1845
+
1846
+ The first source object from which to copy properties.
1847
+
1848
+ ###### source2
1849
+
1850
+ `V`
1851
+
1852
+ The second source object from which to copy properties.
1853
+
1854
+ ##### Returns
1855
+
1856
+ `T` & `U` & `V`
1857
+
1858
+ ##### Inherited from
1859
+
1860
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`assign`](RpcMethodsClientTool.md#assign-2)
1861
+
1862
+ #### Call Signature
1863
+
1864
+ > `static` **assign**\<`T`, `U`, `V`, `W`\>(`target`, `source1`, `source2`, `source3`): `T` & `U` & `V` & `W`
1865
+
1866
+ Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:305
1867
+
1868
+ Copy the values of all of the enumerable own properties from one or more source objects to a
1869
+ target object. Returns the target object.
1870
+
1871
+ ##### Type Parameters
1872
+
1873
+ • **T** *extends* `object`
1874
+
1875
+ • **U**
1876
+
1877
+ • **V**
1878
+
1879
+ • **W**
1880
+
1881
+ ##### Parameters
1882
+
1883
+ ###### target
1884
+
1885
+ `T`
1886
+
1887
+ The target object to copy to.
1888
+
1889
+ ###### source1
1890
+
1891
+ `U`
1892
+
1893
+ The first source object from which to copy properties.
1894
+
1895
+ ###### source2
1896
+
1897
+ `V`
1898
+
1899
+ The second source object from which to copy properties.
1900
+
1901
+ ###### source3
1902
+
1903
+ `W`
1904
+
1905
+ The third source object from which to copy properties.
1906
+
1907
+ ##### Returns
1908
+
1909
+ `T` & `U` & `V` & `W`
1910
+
1911
+ ##### Inherited from
1912
+
1913
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`assign`](RpcMethodsClientTool.md#assign-2)
1914
+
1915
+ #### Call Signature
1916
+
1917
+ > `static` **assign**(`target`, ...`sources`): `any`
1918
+
1919
+ Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:313
1920
+
1921
+ Copy the values of all of the enumerable own properties from one or more source objects to a
1922
+ target object. Returns the target object.
1923
+
1924
+ ##### Parameters
1925
+
1926
+ ###### target
1927
+
1928
+ `object`
1929
+
1930
+ The target object to copy to.
1931
+
1932
+ ###### sources
1933
+
1934
+ ...`any`[]
1935
+
1936
+ One or more source objects from which to copy properties
1937
+
1938
+ ##### Returns
1939
+
1940
+ `any`
1941
+
1942
+ ##### Inherited from
1943
+
1944
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`assign`](RpcMethodsClientTool.md#assign-2)
1945
+
1946
+ ***
1947
+
1948
+ ### create()
1949
+
1950
+ #### Call Signature
1951
+
1952
+ > `static` **create**(`o`): `any`
1953
+
1954
+ Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:188
1955
+
1956
+ Creates an object that has the specified prototype or that has null prototype.
1957
+
1958
+ ##### Parameters
1959
+
1960
+ ###### o
1961
+
1962
+ Object to use as a prototype. May be null.
1963
+
1964
+ `null` | `object`
1965
+
1966
+ ##### Returns
1967
+
1968
+ `any`
1969
+
1970
+ ##### Inherited from
1971
+
1972
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`create`](RpcMethodsClientTool.md#create)
1973
+
1974
+ #### Call Signature
1975
+
1976
+ > `static` **create**(`o`, `properties`): `any`
1977
+
1978
+ Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:195
1979
+
1980
+ Creates an object that has the specified prototype, and that optionally contains specified properties.
1981
+
1982
+ ##### Parameters
1983
+
1984
+ ###### o
1985
+
1986
+ Object to use as a prototype. May be null
1987
+
1988
+ `null` | `object`
1989
+
1990
+ ###### properties
1991
+
1992
+ `PropertyDescriptorMap` & `ThisType`\<`any`\>
1993
+
1994
+ JavaScript object that contains one or more property descriptors.
1995
+
1996
+ ##### Returns
1997
+
1998
+ `any`
1999
+
2000
+ ##### Inherited from
2001
+
2002
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`create`](RpcMethodsClientTool.md#create)
2003
+
2004
+ ***
2005
+
2006
+ ### defineProperties()
2007
+
2008
+ > `static` **defineProperties**(`aTarget`, `aProperties`, `recreate`?): `any`
2009
+
2010
+ Defined in: [property-manager.js/src/advance.d.ts:11](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/advance.d.ts#L11)
2011
+
2012
+ Adds one or more properties to an object, and/or modifies attributes of existing properties.
2013
+
2014
+ #### Parameters
2015
+
2016
+ ##### aTarget
2017
+
2018
+ `any`
2019
+
2020
+ ##### aProperties
2021
+
2022
+ `PropDescriptors`
2023
+
2024
+ ##### recreate?
2025
+
2026
+ `boolean`
2027
+
2028
+ #### Returns
2029
+
2030
+ `any`
2031
+
2032
+ #### Inherited from
2033
+
2034
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`defineProperties`](RpcMethodsClientTool.md#defineproperties-2)
2035
+
2036
+ ***
2037
+
2038
+ ### defineProperty()
2039
+
2040
+ > `static` **defineProperty**\<`T`\>(`o`, `p`, `attributes`): `T`
2041
+
2042
+ Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:203
2043
+
2044
+ Adds a property to an object, or modifies attributes of an existing property.
2045
+
2046
+ #### Type Parameters
2047
+
2048
+ • **T**
2049
+
2050
+ #### Parameters
2051
+
2052
+ ##### o
2053
+
2054
+ `T`
2055
+
2056
+ Object on which to add or modify the property. This can be a native JavaScript object (that is, a user-defined object or a built in object) or a DOM object.
2057
+
2058
+ ##### p
2059
+
2060
+ `PropertyKey`
2061
+
2062
+ The property name.
2063
+
2064
+ ##### attributes
2065
+
2066
+ `PropertyDescriptor` & `ThisType`\<`any`\>
2067
+
2068
+ Descriptor for the property. It can be for a data property or an accessor property.
2069
+
2070
+ #### Returns
2071
+
2072
+ `T`
2073
+
2074
+ #### Inherited from
2075
+
2076
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`defineProperty`](RpcMethodsClientTool.md#defineproperty)
2077
+
2078
+ ***
2079
+
2080
+ ### entries()
2081
+
2082
+ #### Call Signature
2083
+
2084
+ > `static` **entries**\<`T`\>(`o`): \[`string`, `T`\][]
2085
+
2086
+ Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2017.object.d.ts:36
2087
+
2088
+ Returns an array of key/values of the enumerable own properties of an object
2089
+
2090
+ ##### Type Parameters
2091
+
2092
+ • **T**
2093
+
2094
+ ##### Parameters
2095
+
2096
+ ###### o
2097
+
2098
+ Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.
2099
+
2100
+ \{\} | `ArrayLike`\<`T`\>
2101
+
2102
+ ##### Returns
2103
+
2104
+ \[`string`, `T`\][]
2105
+
2106
+ ##### Inherited from
2107
+
2108
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`entries`](RpcMethodsClientTool.md#entries)
2109
+
2110
+ #### Call Signature
2111
+
2112
+ > `static` **entries**(`o`): \[`string`, `any`\][]
2113
+
2114
+ Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2017.object.d.ts:42
2115
+
2116
+ Returns an array of key/values of the enumerable own properties of an object
2117
+
2118
+ ##### Parameters
2119
+
2120
+ ###### o
2121
+
2122
+ Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.
2123
+
2124
+ ##### Returns
2125
+
2126
+ \[`string`, `any`\][]
2127
+
2128
+ ##### Inherited from
2129
+
2130
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`entries`](RpcMethodsClientTool.md#entries)
2131
+
2132
+ ***
2133
+
2134
+ ### fetch()
2135
+
2136
+ > `static` **fetch**(`name`, `objParam`?, ...`args`?): `Promise`\<`any`\>
2137
+
2138
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:98](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/client-tools.ts#L98)
2139
+
2140
+ #### Parameters
2141
+
2142
+ ##### name
2143
+
2144
+ `string`
2145
+
2146
+ ##### objParam?
2147
+
2148
+ `any`
2149
+
2150
+ ##### args?
2151
+
2152
+ ...`any`[]
2153
+
2154
+ #### Returns
2155
+
2156
+ `Promise`\<`any`\>
2157
+
2158
+ #### Inherited from
2159
+
2160
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`fetch`](RpcMethodsClientTool.md#fetch-2)
2161
+
2162
+ ***
2163
+
2164
+ ### freeze()
2165
+
2166
+ #### Call Signature
2167
+
2168
+ > `static` **freeze**\<`T`\>(`f`): `T`
2169
+
2170
+ Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:222
2171
+
2172
+ Prevents the modification of existing property attributes and values, and prevents the addition of new properties.
2173
+
2174
+ ##### Type Parameters
2175
+
2176
+ • **T** *extends* `Function`
2177
+
2178
+ ##### Parameters
2179
+
2180
+ ###### f
2181
+
2182
+ `T`
2183
+
2184
+ Object on which to lock the attributes.
2185
+
2186
+ ##### Returns
2187
+
2188
+ `T`
2189
+
2190
+ ##### Inherited from
2191
+
2192
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`freeze`](RpcMethodsClientTool.md#freeze)
2193
+
2194
+ #### Call Signature
2195
+
2196
+ > `static` **freeze**\<`T`, `U`\>(`o`): `Readonly`\<`T`\>
2197
+
2198
+ Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:228
2199
+
2200
+ Prevents the modification of existing property attributes and values, and prevents the addition of new properties.
2201
+
2202
+ ##### Type Parameters
2203
+
2204
+ • **T** *extends* `object`
2205
+
2206
+ • **U** *extends* `string` \| `number` \| `bigint` \| `boolean` \| `symbol`
2207
+
2208
+ ##### Parameters
2209
+
2210
+ ###### o
2211
+
2212
+ `T`
2213
+
2214
+ Object on which to lock the attributes.
2215
+
2216
+ ##### Returns
2217
+
2218
+ `Readonly`\<`T`\>
2219
+
2220
+ ##### Inherited from
2221
+
2222
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`freeze`](RpcMethodsClientTool.md#freeze)
2223
+
2224
+ #### Call Signature
2225
+
2226
+ > `static` **freeze**\<`T`\>(`o`): `Readonly`\<`T`\>
2227
+
2228
+ Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:234
2229
+
2230
+ Prevents the modification of existing property attributes and values, and prevents the addition of new properties.
2231
+
2232
+ ##### Type Parameters
2233
+
2234
+ • **T**
2235
+
2236
+ ##### Parameters
2237
+
2238
+ ###### o
2239
+
2240
+ `T`
2241
+
2242
+ Object on which to lock the attributes.
2243
+
2244
+ ##### Returns
2245
+
2246
+ `Readonly`\<`T`\>
2247
+
2248
+ ##### Inherited from
2249
+
2250
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`freeze`](RpcMethodsClientTool.md#freeze)
2251
+
2252
+ ***
2253
+
2254
+ ### fromEntries()
2255
+
2256
+ #### Call Signature
2257
+
2258
+ > `static` **fromEntries**\<`T`\>(`entries`): `object`
2259
+
2260
+ Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2019.object.d.ts:26
2261
+
2262
+ Returns an object created by key-value entries for properties and methods
2263
+
2264
+ ##### Type Parameters
2265
+
2266
+ • **T** = `any`
2267
+
2268
+ ##### Parameters
2269
+
2270
+ ###### entries
2271
+
2272
+ `Iterable`\<readonly \[`PropertyKey`, `T`\]\>
2273
+
2274
+ An iterable object that contains key-value entries for properties and methods.
2275
+
2276
+ ##### Returns
2277
+
2278
+ `object`
2279
+
2280
+ ##### Inherited from
2281
+
2282
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`fromEntries`](RpcMethodsClientTool.md#fromentries)
2283
+
2284
+ #### Call Signature
2285
+
2286
+ > `static` **fromEntries**(`entries`): `any`
2287
+
2288
+ Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2019.object.d.ts:32
2289
+
2290
+ Returns an object created by key-value entries for properties and methods
2291
+
2292
+ ##### Parameters
2293
+
2294
+ ###### entries
2295
+
2296
+ `Iterable`\<readonly `any`[]\>
2297
+
2298
+ An iterable object that contains key-value entries for properties and methods.
2299
+
2300
+ ##### Returns
2301
+
2302
+ `any`
2303
+
2304
+ ##### Inherited from
2305
+
2306
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`fromEntries`](RpcMethodsClientTool.md#fromentries)
2307
+
2308
+ ***
2309
+
2310
+ ### get()
2311
+
2312
+ > `static` **get**(`name`): [`ToolFunc`](ToolFunc.md)
2313
+
2314
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:319](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L319)
2315
+
2316
+ Retrieves a registered function by its name or alias.
2317
+
2318
+ #### Parameters
2319
+
2320
+ ##### name
2321
+
2322
+ `string`
2323
+
2324
+ The name or alias of the function to retrieve.
2325
+
2326
+ #### Returns
2327
+
2328
+ [`ToolFunc`](ToolFunc.md)
2329
+
2330
+ The `ToolFunc` instance if found, otherwise `undefined`.
2331
+
2332
+ #### Inherited from
2333
+
2334
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`get`](RpcMethodsClientTool.md#get)
2335
+
2336
+ ***
2337
+
2338
+ ### getAllByTag()
2339
+
2340
+ > `static` **getAllByTag**(`tagName`): [`ToolFunc`](ToolFunc.md)[]
2341
+
2342
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:365](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L365)
2343
+
2344
+ Retrieves all registered functions that have a specific tag.
2345
+
2346
+ #### Parameters
2347
+
2348
+ ##### tagName
2349
+
2350
+ `string`
2351
+
2352
+ The tag to search for.
2353
+
2354
+ #### Returns
2355
+
2356
+ [`ToolFunc`](ToolFunc.md)[]
2357
+
2358
+ An array of matching `ToolFunc` instances.
2359
+
2360
+ #### Inherited from
2361
+
2362
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`getAllByTag`](RpcMethodsClientTool.md#getallbytag)
2363
+
2364
+ ***
2365
+
2366
+ ### getByTag()
2367
+
2368
+ > `static` **getByTag**(`tagName`): `undefined` \| [`ToolFunc`](ToolFunc.md)
2369
+
2370
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:340](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L340)
2371
+
2372
+ Finds the first registered function that has a specific tag.
2373
+
2374
+ #### Parameters
2375
+
2376
+ ##### tagName
2377
+
2378
+ `string`
2379
+
2380
+ The tag to search for.
2381
+
2382
+ #### Returns
2383
+
2384
+ `undefined` \| [`ToolFunc`](ToolFunc.md)
2385
+
2386
+ The first matching `ToolFunc` instance, or `undefined` if none is found.
2387
+
2388
+ #### Inherited from
2389
+
2390
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`getByTag`](RpcMethodsClientTool.md#getbytag)
2391
+
2392
+ ***
2393
+
2394
+ ### getFunc()
2395
+
2396
+ > `static` **getFunc**(`name`): `any`
2397
+
2398
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:431](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L431)
2399
+
2400
+ Retrieves a bound, runnable function reference for a registered function.
2401
+ This reference is suitable for execution with an object of named parameters.
2402
+
2403
+ #### Parameters
2404
+
2405
+ ##### name
2406
+
2407
+ `string`
2408
+
2409
+ The name of the function.
2410
+
2411
+ #### Returns
2412
+
2413
+ `any`
2414
+
2415
+ A bound function reference, or `undefined` if not found.
2416
+
2417
+ #### Inherited from
2418
+
2419
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`getFunc`](RpcMethodsClientTool.md#getfunc-2)
2420
+
2421
+ ***
2422
+
2423
+ ### getFuncWithPos()
2424
+
2425
+ > `static` **getFuncWithPos**(`name`): `any`
2426
+
2427
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:472](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L472)
2428
+
2429
+ Retrieves a bound, runnable function reference for a registered function.
2430
+ This reference is suitable for execution with positional arguments.
2431
+
2432
+ #### Parameters
2433
+
2434
+ ##### name
2435
+
2436
+ `string`
2437
+
2438
+ The name of the function.
2439
+
2440
+ #### Returns
2441
+
2442
+ `any`
2443
+
2444
+ A bound function reference, or `undefined` if not found.
2445
+
2446
+ #### Inherited from
2447
+
2448
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`getFuncWithPos`](RpcMethodsClientTool.md#getfuncwithpos-2)
2449
+
2450
+ ***
2451
+
2452
+ ### getOwnPropertyDescriptor()
2453
+
2454
+ > `static` **getOwnPropertyDescriptor**(`o`, `p`): `undefined` \| `PropertyDescriptor`
2455
+
2456
+ Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:175
2457
+
2458
+ Gets the own property descriptor of the specified object.
2459
+ An own property descriptor is one that is defined directly on the object and is not inherited from the object's prototype.
2460
+
2461
+ #### Parameters
2462
+
2463
+ ##### o
2464
+
2465
+ `any`
2466
+
2467
+ Object that contains the property.
2468
+
2469
+ ##### p
2470
+
2471
+ `PropertyKey`
2472
+
2473
+ Name of the property.
2474
+
2475
+ #### Returns
2476
+
2477
+ `undefined` \| `PropertyDescriptor`
2478
+
2479
+ #### Inherited from
2480
+
2481
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`getOwnPropertyDescriptor`](RpcMethodsClientTool.md#getownpropertydescriptor)
2482
+
2483
+ ***
2484
+
2485
+ ### getOwnPropertyDescriptors()
2486
+
2487
+ > `static` **getOwnPropertyDescriptors**\<`T`\>(`o`): \{ \[P in string \| number \| symbol\]: TypedPropertyDescriptor\<T\[P\]\> \} & `object`
2488
+
2489
+ Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2017.object.d.ts:48
2490
+
2491
+ Returns an object containing all own property descriptors of an object
2492
+
2493
+ #### Type Parameters
2494
+
2495
+ • **T**
2496
+
2497
+ #### Parameters
2498
+
2499
+ ##### o
2500
+
2501
+ `T`
2502
+
2503
+ Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.
2504
+
2505
+ #### Returns
2506
+
2507
+ \{ \[P in string \| number \| symbol\]: TypedPropertyDescriptor\<T\[P\]\> \} & `object`
2508
+
2509
+ #### Inherited from
2510
+
2511
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`getOwnPropertyDescriptors`](RpcMethodsClientTool.md#getownpropertydescriptors)
2512
+
2513
+ ***
2514
+
2515
+ ### getOwnPropertyNames()
2516
+
2517
+ > `static` **getOwnPropertyNames**(`o`): `string`[]
2518
+
2519
+ Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:182
2520
+
2521
+ Returns the names of the own properties of an object. The own properties of an object are those that are defined directly
2522
+ on that object, and are not inherited from the object's prototype. The properties of an object include both fields (objects) and functions.
2523
+
2524
+ #### Parameters
2525
+
2526
+ ##### o
2527
+
2528
+ `any`
2529
+
2530
+ Object that contains the own properties.
2531
+
2532
+ #### Returns
2533
+
2534
+ `string`[]
2535
+
2536
+ #### Inherited from
2537
+
2538
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`getOwnPropertyNames`](RpcMethodsClientTool.md#getownpropertynames)
2539
+
2540
+ ***
2541
+
2542
+ ### getOwnPropertySymbols()
2543
+
2544
+ > `static` **getOwnPropertySymbols**(`o`): `symbol`[]
2545
+
2546
+ Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:319
2547
+
2548
+ Returns an array of all symbol properties found directly on object o.
2549
+
2550
+ #### Parameters
2551
+
2552
+ ##### o
2553
+
2554
+ `any`
2555
+
2556
+ Object to retrieve the symbols from.
2557
+
2558
+ #### Returns
2559
+
2560
+ `symbol`[]
2561
+
2562
+ #### Inherited from
2563
+
2564
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`getOwnPropertySymbols`](RpcMethodsClientTool.md#getownpropertysymbols)
2565
+
2566
+ ***
2567
+
2568
+ ### getProperties()
2569
+
2570
+ > `static` **getProperties**(): `PropDescriptors`
2571
+
2572
+ Defined in: [property-manager.js/src/advance.d.ts:10](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/advance.d.ts#L10)
2573
+
2574
+ get all properties descriptor include inherited.
2575
+
2576
+ #### Returns
2577
+
2578
+ `PropDescriptors`
2579
+
2580
+ #### Inherited from
2581
+
2582
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`getProperties`](RpcMethodsClientTool.md#getproperties-2)
2583
+
2584
+ ***
2585
+
2586
+ ### getPrototypeOf()
2587
+
2588
+ > `static` **getPrototypeOf**(`o`): `any`
2589
+
2590
+ Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:167
2591
+
2592
+ Returns the prototype of an object.
2593
+
2594
+ #### Parameters
2595
+
2596
+ ##### o
2597
+
2598
+ `any`
2599
+
2600
+ The object that references the prototype.
2601
+
2602
+ #### Returns
2603
+
2604
+ `any`
2605
+
2606
+ #### Inherited from
2607
+
2608
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`getPrototypeOf`](RpcMethodsClientTool.md#getprototypeof)
2609
+
2610
+ ***
2611
+
2612
+ ### hasAsyncFeature()
2613
+
2614
+ > `static` **hasAsyncFeature**(`feature`): `boolean`
2615
+
2616
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:388](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L388)
2617
+
2618
+ Checks if any registered function has a specific asynchronous feature.
2619
+
2620
+ #### Parameters
2621
+
2622
+ ##### feature
2623
+
2624
+ [`AsyncFeatureBits`](../enumerations/AsyncFeatureBits.md)
2625
+
2626
+ The async feature bit to check for.
2627
+
2628
+ #### Returns
2629
+
2630
+ `boolean`
2631
+
2632
+ `true` if the feature is present in any function, otherwise `false`.
2633
+
2634
+ #### Inherited from
2635
+
2636
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`hasAsyncFeature`](RpcMethodsClientTool.md#hasasyncfeature-2)
2637
+
2638
+ ***
2639
+
2640
+ ### hasOwn()
2641
+
2642
+ > `static` **hasOwn**(`o`, `v`): `boolean`
2643
+
2644
+ Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2022.object.d.ts:25
2645
+
2646
+ Determines whether an object has a property with the specified name.
2647
+
2648
+ #### Parameters
2649
+
2650
+ ##### o
2651
+
2652
+ `object`
2653
+
2654
+ An object.
2655
+
2656
+ ##### v
2657
+
2658
+ `PropertyKey`
2659
+
2660
+ A property name.
2661
+
2662
+ #### Returns
2663
+
2664
+ `boolean`
2665
+
2666
+ #### Inherited from
2667
+
2668
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`hasOwn`](RpcMethodsClientTool.md#hasown)
2669
+
2670
+ ***
2671
+
2672
+ ### is()
2673
+
2674
+ > `static` **is**(`value1`, `value2`): `boolean`
2675
+
2676
+ Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:332
2677
+
2678
+ Returns true if the values are the same value, false otherwise.
2679
+
2680
+ #### Parameters
2681
+
2682
+ ##### value1
2683
+
2684
+ `any`
2685
+
2686
+ The first value.
2687
+
2688
+ ##### value2
2689
+
2690
+ `any`
2691
+
2692
+ The second value.
2693
+
2694
+ #### Returns
2695
+
2696
+ `boolean`
2697
+
2698
+ #### Inherited from
2699
+
2700
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`is`](RpcMethodsClientTool.md#is)
2701
+
2702
+ ***
2703
+
2704
+ ### isExtensible()
2705
+
2706
+ > `static` **isExtensible**(`o`): `boolean`
2707
+
2708
+ Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:258
2709
+
2710
+ Returns a value that indicates whether new properties can be added to an object.
2711
+
2712
+ #### Parameters
2713
+
2714
+ ##### o
2715
+
2716
+ `any`
2717
+
2718
+ Object to test.
2719
+
2720
+ #### Returns
2721
+
2722
+ `boolean`
2723
+
2724
+ #### Inherited from
2725
+
2726
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`isExtensible`](RpcMethodsClientTool.md#isextensible)
2727
+
2728
+ ***
2729
+
2730
+ ### isFrozen()
2731
+
2732
+ > `static` **isFrozen**(`o`): `boolean`
2733
+
2734
+ Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:252
2735
+
2736
+ Returns true if existing property attributes and values cannot be modified in an object, and new properties cannot be added to the object.
2737
+
2738
+ #### Parameters
2739
+
2740
+ ##### o
2741
+
2742
+ `any`
2743
+
2744
+ Object to test.
2745
+
2746
+ #### Returns
2747
+
2748
+ `boolean`
2749
+
2750
+ #### Inherited from
2751
+
2752
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`isFrozen`](RpcMethodsClientTool.md#isfrozen)
2753
+
2754
+ ***
2755
+
2756
+ ### isSealed()
2757
+
2758
+ > `static` **isSealed**(`o`): `boolean`
2759
+
2760
+ Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:246
2761
+
2762
+ Returns true if existing property attributes cannot be modified in an object and new properties cannot be added to the object.
2763
+
2764
+ #### Parameters
2765
+
2766
+ ##### o
2767
+
2768
+ `any`
2769
+
2770
+ Object to test.
2771
+
2772
+ #### Returns
2773
+
2774
+ `boolean`
2775
+
2776
+ #### Inherited from
2777
+
2778
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`isSealed`](RpcMethodsClientTool.md#issealed)
2779
+
2780
+ ***
2781
+
2782
+ ### keys()
2783
+
2784
+ #### Call Signature
2785
+
2786
+ > `static` **keys**(`o`): `string`[]
2787
+
2788
+ Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:264
2789
+
2790
+ Returns the names of the enumerable string properties and methods of an object.
2791
+
2792
+ ##### Parameters
2793
+
2794
+ ###### o
2795
+
2796
+ `object`
2797
+
2798
+ Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.
2799
+
2800
+ ##### Returns
2801
+
2802
+ `string`[]
2803
+
2804
+ ##### Inherited from
2805
+
2806
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`keys`](RpcMethodsClientTool.md#keys)
2807
+
2808
+ #### Call Signature
2809
+
2810
+ > `static` **keys**(`o`): `string`[]
2811
+
2812
+ Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:325
2813
+
2814
+ Returns the names of the enumerable string properties and methods of an object.
2815
+
2816
+ ##### Parameters
2817
+
2818
+ ###### o
2819
+
2820
+ Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.
2821
+
2822
+ ##### Returns
2823
+
2824
+ `string`[]
2825
+
2826
+ ##### Inherited from
2827
+
2828
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`keys`](RpcMethodsClientTool.md#keys)
2829
+
2830
+ ***
2831
+
2832
+ ### list()
2833
+
2834
+ > `static` **list**(): [`Funcs`](../interfaces/Funcs.md)
2835
+
2836
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:331](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L331)
2837
+
2838
+ Returns the complete map of all registered functions.
2839
+
2840
+ #### Returns
2841
+
2842
+ [`Funcs`](../interfaces/Funcs.md)
2843
+
2844
+ The map of `ToolFunc` instances.
2845
+
2846
+ #### Inherited from
2847
+
2848
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`list`](RpcMethodsClientTool.md#list)
2849
+
2850
+ ***
2851
+
2852
+ ### loadFrom()
2853
+
2854
+ > `static` **loadFrom**(`items`?): `Promise`\<[`Funcs`](../interfaces/Funcs.md)\>
2855
+
2856
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:68](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/client-tools.ts#L68)
2857
+
2858
+ Loads tool definitions from the remote server via the configured transport.
2859
+ This method populates the local `ToolFunc` registry with `ClientTools` stubs.
2860
+
2861
+ #### Parameters
2862
+
2863
+ ##### items?
2864
+
2865
+ [`Funcs`](../interfaces/Funcs.md)
2866
+
2867
+ #### Returns
2868
+
2869
+ `Promise`\<[`Funcs`](../interfaces/Funcs.md)\>
2870
+
2871
+ #### Inherited from
2872
+
2873
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`loadFrom`](RpcMethodsClientTool.md#loadfrom)
2874
+
2875
+ ***
2876
+
2877
+ ### loadFromSync()
2878
+
2879
+ > `static` **loadFromSync**(`items`): `void`
2880
+
2881
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:84](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/client-tools.ts#L84)
2882
+
2883
+ Synchronously loads tool definitions from a provided object, registering
2884
+ each one as a `ClientTools` instance.
2885
+
2886
+ #### Parameters
2887
+
2888
+ ##### items
2889
+
2890
+ [`Funcs`](../interfaces/Funcs.md)
2891
+
2892
+ A map of tool function metadata, typically from a server.
2893
+
2894
+ #### Returns
2895
+
2896
+ `void`
2897
+
2898
+ #### Inherited from
2899
+
2900
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`loadFromSync`](RpcMethodsClientTool.md#loadfromsync)
2901
+
2902
+ ***
2903
+
2904
+ ### preventExtensions()
2905
+
2906
+ > `static` **preventExtensions**\<`T`\>(`o`): `T`
2907
+
2908
+ Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:240
2909
+
2910
+ Prevents the addition of new properties to an object.
2911
+
2912
+ #### Type Parameters
2913
+
2914
+ • **T**
2915
+
2916
+ #### Parameters
2917
+
2918
+ ##### o
2919
+
2920
+ `T`
2921
+
2922
+ Object to make non-extensible.
2923
+
2924
+ #### Returns
2925
+
2926
+ `T`
2927
+
2928
+ #### Inherited from
2929
+
2930
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`preventExtensions`](RpcMethodsClientTool.md#preventextensions)
2931
+
2932
+ ***
2933
+
2934
+ ### register()
2935
+
2936
+ #### Call Signature
2937
+
2938
+ > `static` **register**(`name`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
2939
+
2940
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:495](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L495)
2941
+
2942
+ Registers a new tool function.
2943
+
2944
+ ##### Parameters
2945
+
2946
+ ###### name
2947
+
2948
+ `string`
2949
+
2950
+ The name of the function.
2951
+
2952
+ ###### options
2953
+
2954
+ [`FuncItem`](../interfaces/FuncItem.md)
2955
+
2956
+ The function's configuration.
2957
+
2958
+ ##### Returns
2959
+
2960
+ `boolean` \| [`ToolFunc`](ToolFunc.md)
2961
+
2962
+ The new `ToolFunc` instance, or `false` if a function with that name already exists.
2963
+
2964
+ The new `ToolFunc` instance, or `false` if a function with that name already exists.
2965
+
2966
+ The new `ToolFunc` instance, or `false` if a function with that name already exists.
2967
+
2968
+ ##### Inherited from
2969
+
2970
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`register`](RpcMethodsClientTool.md#register-2)
2971
+
2972
+ #### Call Signature
2973
+
2974
+ > `static` **register**(`func`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
2975
+
2976
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:496](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L496)
2977
+
2978
+ Registers a new tool function.
2979
+
2980
+ ##### Parameters
2981
+
2982
+ ###### func
2983
+
2984
+ `Function`
2985
+
2986
+ The function implementation.
2987
+
2988
+ ###### options
2989
+
2990
+ [`FuncItem`](../interfaces/FuncItem.md)
2991
+
2992
+ The function's configuration.
2993
+
2994
+ ##### Returns
2995
+
2996
+ `boolean` \| [`ToolFunc`](ToolFunc.md)
2997
+
2998
+ The new `ToolFunc` instance, or `false` if a function with that name already exists.
2999
+
3000
+ The new `ToolFunc` instance, or `false` if a function with that name already exists.
3001
+
3002
+ The new `ToolFunc` instance, or `false` if a function with that name already exists.
3003
+
3004
+ ##### Inherited from
3005
+
3006
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`register`](RpcMethodsClientTool.md#register-2)
3007
+
3008
+ #### Call Signature
3009
+
3010
+ > `static` **register**(`name`, `options`?): `boolean` \| [`ToolFunc`](ToolFunc.md)
3011
+
3012
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:497](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L497)
3013
+
3014
+ Registers a new tool function.
3015
+
3016
+ ##### Parameters
3017
+
3018
+ ###### name
3019
+
3020
+ The name of the function.
3021
+
3022
+ `string` | `Function` | [`ToolFunc`](ToolFunc.md) | [`FuncItem`](../interfaces/FuncItem.md)
3023
+
3024
+ ###### options?
3025
+
3026
+ [`FuncItem`](../interfaces/FuncItem.md)
3027
+
3028
+ The function's configuration.
3029
+
3030
+ ##### Returns
3031
+
3032
+ `boolean` \| [`ToolFunc`](ToolFunc.md)
3033
+
3034
+ The new `ToolFunc` instance, or `false` if a function with that name already exists.
3035
+
3036
+ The new `ToolFunc` instance, or `false` if a function with that name already exists.
3037
+
3038
+ The new `ToolFunc` instance, or `false` if a function with that name already exists.
3039
+
3040
+ ##### Inherited from
3041
+
3042
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`register`](RpcMethodsClientTool.md#register-2)
3043
+
3044
+ ***
3045
+
3046
+ ### run()
3047
+
3048
+ > `static` **run**(`name`, `params`?): `Promise`\<`any`\>
3049
+
3050
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:402](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L402)
3051
+
3052
+ Asynchronously executes a registered function by name with named parameters.
3053
+
3054
+ #### Parameters
3055
+
3056
+ ##### name
3057
+
3058
+ `string`
3059
+
3060
+ The name of the function to run.
3061
+
3062
+ ##### params?
3063
+
3064
+ `any`
3065
+
3066
+ The parameters object for the function.
3067
+
3068
+ #### Returns
3069
+
3070
+ `Promise`\<`any`\>
3071
+
3072
+ A promise that resolves with the function's result.
3073
+
3074
+ #### Throws
3075
+
3076
+ If the function with the given name is not found.
3077
+
3078
+ #### Inherited from
3079
+
3080
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`run`](RpcMethodsClientTool.md#run-2)
3081
+
3082
+ ***
3083
+
3084
+ ### runSync()
3085
+
3086
+ > `static` **runSync**(`name`, `params`?): `any`
3087
+
3088
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:417](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L417)
3089
+
3090
+ Synchronously executes a registered function by name with named parameters.
3091
+
3092
+ #### Parameters
3093
+
3094
+ ##### name
3095
+
3096
+ `string`
3097
+
3098
+ The name of the function to run.
3099
+
3100
+ ##### params?
3101
+
3102
+ `any`
3103
+
3104
+ The parameters object for the function.
3105
+
3106
+ #### Returns
3107
+
3108
+ `any`
3109
+
3110
+ The result of the function's execution.
3111
+
3112
+ #### Throws
3113
+
3114
+ If the function with the given name is not found.
3115
+
3116
+ #### Inherited from
3117
+
3118
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`runSync`](RpcMethodsClientTool.md#runsync-2)
3119
+
3120
+ ***
3121
+
3122
+ ### runWithPos()
3123
+
3124
+ > `static` **runWithPos**(`name`, ...`params`): `Promise`\<`any`\>
3125
+
3126
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:443](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L443)
3127
+
3128
+ Asynchronously executes a function using positional arguments.
3129
+
3130
+ #### Parameters
3131
+
3132
+ ##### name
3133
+
3134
+ `string`
3135
+
3136
+ The name of the function to run.
3137
+
3138
+ ##### params
3139
+
3140
+ ...`any`[]
3141
+
3142
+ Positional arguments to pass to the function.
3143
+
3144
+ #### Returns
3145
+
3146
+ `Promise`\<`any`\>
3147
+
3148
+ A promise that resolves with the function's result.
3149
+
3150
+ #### Throws
3151
+
3152
+ If the function with the given name is not found.
3153
+
3154
+ #### Inherited from
3155
+
3156
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`runWithPos`](RpcMethodsClientTool.md#runwithpos-2)
3157
+
3158
+ ***
3159
+
3160
+ ### runWithPosSync()
3161
+
3162
+ > `static` **runWithPosSync**(`name`, ...`params`): `any`
3163
+
3164
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:458](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L458)
3165
+
3166
+ Synchronously executes a function using positional arguments.
3167
+
3168
+ #### Parameters
3169
+
3170
+ ##### name
3171
+
3172
+ `string`
3173
+
3174
+ The name of the function to run.
3175
+
3176
+ ##### params
3177
+
3178
+ ...`any`[]
3179
+
3180
+ Positional arguments to pass to the function.
3181
+
3182
+ #### Returns
3183
+
3184
+ `any`
3185
+
3186
+ The result of the function's execution.
3187
+
3188
+ #### Throws
3189
+
3190
+ If the function with the given name is not found.
3191
+
3192
+ #### Inherited from
3193
+
3194
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`runWithPosSync`](RpcMethodsClientTool.md#runwithpossync-2)
3195
+
3196
+ ***
3197
+
3198
+ ### seal()
3199
+
3200
+ > `static` **seal**\<`T`\>(`o`): `T`
3201
+
3202
+ Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:216
3203
+
3204
+ Prevents the modification of attributes of existing properties, and prevents the addition of new properties.
3205
+
3206
+ #### Type Parameters
3207
+
3208
+ • **T**
3209
+
3210
+ #### Parameters
3211
+
3212
+ ##### o
3213
+
3214
+ `T`
3215
+
3216
+ Object on which to lock the attributes.
3217
+
3218
+ #### Returns
3219
+
3220
+ `T`
3221
+
3222
+ #### Inherited from
3223
+
3224
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`seal`](RpcMethodsClientTool.md#seal)
3225
+
3226
+ ***
3227
+
3228
+ ### setPrototypeOf()
3229
+
3230
+ > `static` **setPrototypeOf**(`o`, `proto`): `any`
3231
+
3232
+ Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:339
3233
+
3234
+ Sets the prototype of a specified object o to object proto or null. Returns the object o.
3235
+
3236
+ #### Parameters
3237
+
3238
+ ##### o
3239
+
3240
+ `any`
3241
+
3242
+ The object to change its prototype.
3243
+
3244
+ ##### proto
3245
+
3246
+ The value of the new prototype or null.
3247
+
3248
+ `null` | `object`
3249
+
3250
+ #### Returns
3251
+
3252
+ `any`
3253
+
3254
+ #### Inherited from
3255
+
3256
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`setPrototypeOf`](RpcMethodsClientTool.md#setprototypeof)
3257
+
3258
+ ***
3259
+
3260
+ ### setTransport()
3261
+
3262
+ > `static` **setTransport**(`transport`): `void`
3263
+
3264
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:50](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/client-tools.ts#L50)
3265
+
3266
+ Injects the client-side transport implementation. This is a crucial step
3267
+ to enable communication with the server.
3268
+
3269
+ #### Parameters
3270
+
3271
+ ##### transport
3272
+
3273
+ [`IClientToolTransport`](../interfaces/IClientToolTransport.md)
3274
+
3275
+ The transport instance to use for all client-server communication.
3276
+
3277
+ #### Returns
3278
+
3279
+ `void`
3280
+
3281
+ #### Inherited from
3282
+
3283
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`setTransport`](RpcMethodsClientTool.md#settransport)
3284
+
3285
+ ***
3286
+
3287
+ ### unregister()
3288
+
3289
+ > `static` **unregister**(`name`): `undefined` \| [`ToolFunc`](ToolFunc.md)
3290
+
3291
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:547](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L547)
3292
+
3293
+ Unregisters a function by its name, also removing any associated aliases.
3294
+
3295
+ #### Parameters
3296
+
3297
+ ##### name
3298
+
3299
+ `string`
3300
+
3301
+ The name of the function to unregister.
3302
+
3303
+ #### Returns
3304
+
3305
+ `undefined` \| [`ToolFunc`](ToolFunc.md)
3306
+
3307
+ The unregistered `ToolFunc` instance, or `undefined` if it was not found.
3308
+
3309
+ #### Inherited from
3310
+
3311
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`unregister`](RpcMethodsClientTool.md#unregister-2)
3312
+
3313
+ ***
3314
+
3315
+ ### values()
3316
+
3317
+ #### Call Signature
3318
+
3319
+ > `static` **values**\<`T`\>(`o`): `T`[]
3320
+
3321
+ Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2017.object.d.ts:24
3322
+
3323
+ Returns an array of values of the enumerable own properties of an object
3324
+
3325
+ ##### Type Parameters
3326
+
3327
+ • **T**
3328
+
3329
+ ##### Parameters
3330
+
3331
+ ###### o
3332
+
3333
+ Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.
3334
+
3335
+ \{\} | `ArrayLike`\<`T`\>
3336
+
3337
+ ##### Returns
3338
+
3339
+ `T`[]
3340
+
3341
+ ##### Inherited from
3342
+
3343
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`values`](RpcMethodsClientTool.md#values)
3344
+
3345
+ #### Call Signature
3346
+
3347
+ > `static` **values**(`o`): `any`[]
3348
+
3349
+ Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2017.object.d.ts:30
3350
+
3351
+ Returns an array of values of the enumerable own properties of an object
3352
+
3353
+ ##### Parameters
3354
+
3355
+ ###### o
3356
+
3357
+ Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.
3358
+
3359
+ ##### Returns
3360
+
3361
+ `any`[]
3362
+
3363
+ ##### Inherited from
3364
+
3365
+ [`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`values`](RpcMethodsClientTool.md#values)