@isdk/ai-tool 0.5.8 → 0.7.0

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