@isdk/ai-tool 0.5.2 → 0.5.4

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 (331) hide show
  1. package/dist/funcs.js +1 -1
  2. package/dist/index.js +1 -1
  3. package/docs/README.md +250 -0
  4. package/docs/_media/CONTRIBUTING.md +18 -0
  5. package/docs/_media/LICENSE-MIT +22 -0
  6. package/docs/classes/AbortError.md +366 -0
  7. package/docs/classes/AlreadyExistsError.md +346 -0
  8. package/docs/classes/BaseError.md +359 -0
  9. package/docs/classes/BinarySemaphore.md +418 -0
  10. package/docs/classes/CancelableAbility.md +467 -0
  11. package/docs/classes/ClientTools.md +2715 -0
  12. package/docs/classes/CommonError.md +377 -0
  13. package/docs/classes/ConfigFile.md +353 -0
  14. package/docs/classes/EnvPromptTemplate.md +1158 -0
  15. package/docs/classes/EventClient.md +3149 -0
  16. package/docs/classes/EventEmitter.md +299 -0
  17. package/docs/classes/EventServer.md +3175 -0
  18. package/docs/classes/EventToolFunc.md +2557 -0
  19. package/docs/classes/FStringPromptTemplate.md +1158 -0
  20. package/docs/classes/FewShotPromptTemplate.md +1180 -0
  21. package/docs/classes/GolangPromptTemplate.md +1158 -0
  22. package/docs/classes/HFEnvironment.md +184 -0
  23. package/docs/classes/HFInterpreter.md +77 -0
  24. package/docs/classes/HFTemplate.md +67 -0
  25. package/docs/classes/HfPromptTemplate.md +1158 -0
  26. package/docs/classes/IntSet.md +216 -0
  27. package/docs/classes/LRUCache.md +601 -0
  28. package/docs/classes/NotFoundError.md +346 -0
  29. package/docs/classes/NotImplementationError.md +346 -0
  30. package/docs/classes/PromptExampleSelector.md +195 -0
  31. package/docs/classes/PromptTemplate.md +1088 -0
  32. package/docs/classes/ReadableStreamError.md +366 -0
  33. package/docs/classes/ResClientTools.md +2431 -0
  34. package/docs/classes/ResServerTools.md +2407 -0
  35. package/docs/classes/SSEChannel.md +270 -0
  36. package/docs/classes/Semaphore.md +538 -0
  37. package/docs/classes/ServerTools.md +2623 -0
  38. package/docs/classes/SignalGate.md +182 -0
  39. package/docs/classes/TaskAbortController.md +131 -0
  40. package/docs/classes/ToolFunc.md +2177 -0
  41. package/docs/classes/YamlTypeBaseObject.md +31 -0
  42. package/docs/enumerations/AsyncFeatureBits.md +33 -0
  43. package/docs/enumerations/AsyncFeatures.md +33 -0
  44. package/docs/enumerations/ErrorCode.md +177 -0
  45. package/docs/enumerations/HashAlgorithm.md +97 -0
  46. package/docs/functions/AIArgProcessor.md +33 -0
  47. package/docs/functions/AIStream.md +52 -0
  48. package/docs/functions/ChoiceArgProcessor.md +33 -0
  49. package/docs/functions/ObjectArgsToArgsInfo.md +29 -0
  50. package/docs/functions/RateLimit.md +37 -0
  51. package/docs/functions/TemplateArgProcessor.md +33 -0
  52. package/docs/functions/assignDirs.md +33 -0
  53. package/docs/functions/backendEventable.md +29 -0
  54. package/docs/functions/beforeShutdown.md +29 -0
  55. package/docs/functions/canonicalize.md +21 -0
  56. package/docs/functions/completeSentences.md +25 -0
  57. package/docs/functions/concatText.md +25 -0
  58. package/docs/functions/countLLMTokens.md +25 -0
  59. package/docs/functions/countRegexMatches.md +35 -0
  60. package/docs/functions/createAbilityInjector.md +119 -0
  61. package/docs/functions/createCallbacksTransformer.md +49 -0
  62. package/docs/functions/createEmptyReadableStream.md +21 -0
  63. package/docs/functions/createEndWithRepetitionDetector.md +31 -0
  64. package/docs/functions/createError.md +39 -0
  65. package/docs/functions/createEventStreamTransformer.md +33 -0
  66. package/docs/functions/createHfValueFunc.md +31 -0
  67. package/docs/functions/createLRUCache.md +25 -0
  68. package/docs/functions/createYamlObjectTag.md +25 -0
  69. package/docs/functions/dateToText.md +25 -0
  70. package/docs/functions/decodeCharset.md +25 -0
  71. package/docs/functions/detectCharset.md +25 -0
  72. package/docs/functions/encodeLLMTokens.md +25 -0
  73. package/docs/functions/ensureQuoted.md +25 -0
  74. package/docs/functions/eventable.md +82 -0
  75. package/docs/functions/expandConfig.md +25 -0
  76. package/docs/functions/expandEnv.md +40 -0
  77. package/docs/functions/expandObjEnv.md +58 -0
  78. package/docs/functions/expandPath.md +25 -0
  79. package/docs/functions/extNameLevel.md +43 -0
  80. package/docs/functions/fileIsExists.md +34 -0
  81. package/docs/functions/filenameReservedRegex.md +20 -0
  82. package/docs/functions/filterValidFnScope.md +21 -0
  83. package/docs/functions/findIndexNonEmptyFrom.md +25 -0
  84. package/docs/functions/findPort.md +25 -0
  85. package/docs/functions/formatISO.md +69 -0
  86. package/docs/functions/formatTextWithSpace.md +63 -0
  87. package/docs/functions/getAllEnumKeys.md +31 -0
  88. package/docs/functions/getConfigFileNames.md +25 -0
  89. package/docs/functions/getConfigs.md +25 -0
  90. package/docs/functions/getEnvVairables.md +21 -0
  91. package/docs/functions/getFileMetaInfo.md +21 -0
  92. package/docs/functions/getHashAlgoBySize.md +21 -0
  93. package/docs/functions/getKeysPath.md +38 -0
  94. package/docs/functions/getLLMTokenizer.md +21 -0
  95. package/docs/functions/getMultiLevelExtname.md +33 -0
  96. package/docs/functions/getPackageDir.md +39 -0
  97. package/docs/functions/getRealFilepath.md +34 -0
  98. package/docs/functions/getResponseErrorReadableStream.md +21 -0
  99. package/docs/functions/getXDGConfigs.md +37 -0
  100. package/docs/functions/hasDirectoryIn.md +40 -0
  101. package/docs/functions/hash.md +25 -0
  102. package/docs/functions/hashFile.md +25 -0
  103. package/docs/functions/hashStream.md +25 -0
  104. package/docs/functions/hfParse.md +24 -0
  105. package/docs/functions/hfTokenize.md +27 -0
  106. package/docs/functions/initShutdown.md +15 -0
  107. package/docs/functions/interpolateEnv.md +29 -0
  108. package/docs/functions/interpolateFString.md +29 -0
  109. package/docs/functions/interpolateGolangTemplate.md +35 -0
  110. package/docs/functions/isLangUsingSpaces.md +21 -0
  111. package/docs/functions/isListItemString.md +21 -0
  112. package/docs/functions/isModelNameMatched.md +47 -0
  113. package/docs/functions/isPunctuationChar.md +36 -0
  114. package/docs/functions/isQuoted.md +21 -0
  115. package/docs/functions/isRegExp.md +21 -0
  116. package/docs/functions/isSameString.md +36 -0
  117. package/docs/functions/isSectionString.md +25 -0
  118. package/docs/functions/isSentenceEnding.md +21 -0
  119. package/docs/functions/isSepLineString.md +21 -0
  120. package/docs/functions/isStrWrapped.md +25 -0
  121. package/docs/functions/isSubdirectory.md +41 -0
  122. package/docs/functions/isTitleString.md +25 -0
  123. package/docs/functions/isValidFilename.md +38 -0
  124. package/docs/functions/isValidFilepath.md +27 -0
  125. package/docs/functions/isWebStream.md +21 -0
  126. package/docs/functions/jsonFilterToWhere.md +47 -0
  127. package/docs/functions/jsonToMarkdownStr.md +39 -0
  128. package/docs/functions/loadAIConfig.md +21 -0
  129. package/docs/functions/loadConfig.md +25 -0
  130. package/docs/functions/loadConfigFile.md +25 -0
  131. package/docs/functions/loadFileFromPaths.md +64 -0
  132. package/docs/functions/loadTextFromPaths.md +37 -0
  133. package/docs/functions/lrucache.md +35 -0
  134. package/docs/functions/makeToolFuncCancelable.md +29 -0
  135. package/docs/functions/matchUrlProtocol.md +48 -0
  136. package/docs/functions/memoize.md +29 -0
  137. package/docs/functions/messagesToText.md +21 -0
  138. package/docs/functions/paramsSizeToScaleStr.md +34 -0
  139. package/docs/functions/parseCommand.md +29 -0
  140. package/docs/functions/parseDateFormat.md +362 -0
  141. package/docs/functions/parseFString.md +26 -0
  142. package/docs/functions/parseISO.md +70 -0
  143. package/docs/functions/parseJsJson.md +40 -0
  144. package/docs/functions/parseJsJsonSimpleSync.md +25 -0
  145. package/docs/functions/parseObjectArgInfo.md +33 -0
  146. package/docs/functions/parseObjectArgumentInfos.md +29 -0
  147. package/docs/functions/parseObjectArguments.md +72 -0
  148. package/docs/functions/parseObjectArgumentsAsArgInfos.md +46 -0
  149. package/docs/functions/parseYaml.md +25 -0
  150. package/docs/functions/quoteStr.md +21 -0
  151. package/docs/functions/reControlCharsRegex.md +19 -0
  152. package/docs/functions/readFilenamesRecursiveSync.md +53 -0
  153. package/docs/functions/readTextFileChunks.md +53 -0
  154. package/docs/functions/readTextFileChunksEx.md +25 -0
  155. package/docs/functions/readableFromAsyncIterable.md +28 -0
  156. package/docs/functions/registerCoreTools.md +15 -0
  157. package/docs/functions/registerYamlTag.md +21 -0
  158. package/docs/functions/removeMarkdownBold.md +25 -0
  159. package/docs/functions/removeMarkdownBoldAndItalic.md +25 -0
  160. package/docs/functions/removeMarkdownItalic.md +25 -0
  161. package/docs/functions/replaceWithPlaceholder.md +43 -0
  162. package/docs/functions/restoreFromPlacehoders.md +49 -0
  163. package/docs/functions/sanitizeFilename.md +39 -0
  164. package/docs/functions/sanitizeFilepath.md +33 -0
  165. package/docs/functions/saveConfigFile.md +29 -0
  166. package/docs/functions/scaleStrToParamsSize.md +27 -0
  167. package/docs/functions/shutdown.md +33 -0
  168. package/docs/functions/simplifyObjectArguments.md +21 -0
  169. package/docs/functions/sortedValues.md +25 -0
  170. package/docs/functions/splitChunks.md +25 -0
  171. package/docs/functions/splitParagraph.md +34 -0
  172. package/docs/functions/splitSentence.md +39 -0
  173. package/docs/functions/stringifyYaml.md +25 -0
  174. package/docs/functions/stripConsoleColor.md +21 -0
  175. package/docs/functions/textToDate.md +25 -0
  176. package/docs/functions/throwError.md +41 -0
  177. package/docs/functions/toDate.md +74 -0
  178. package/docs/functions/toDateTime.md +21 -0
  179. package/docs/functions/toRegExp.md +34 -0
  180. package/docs/functions/trimStartOfStreamHelper.md +41 -0
  181. package/docs/functions/truncTo.md +51 -0
  182. package/docs/functions/truncateByToken.md +25 -0
  183. package/docs/functions/truncateToTokenLimit.md +46 -0
  184. package/docs/functions/truncateToTokenLimitEx.md +25 -0
  185. package/docs/functions/uuid.md +25 -0
  186. package/docs/functions/uuidParse.md +21 -0
  187. package/docs/functions/uuidStringify.md +25 -0
  188. package/docs/functions/uuidValidate.md +21 -0
  189. package/docs/functions/uuidVersion.md +21 -0
  190. package/docs/functions/uuidv1.md +55 -0
  191. package/docs/functions/uuidv4.md +55 -0
  192. package/docs/functions/uuidv5.md +63 -0
  193. package/docs/functions/wait.md +21 -0
  194. package/docs/functions/wrapEventEmitter.md +27 -0
  195. package/docs/functions/xxhash.md +29 -0
  196. package/docs/functions/xxhash32.md +25 -0
  197. package/docs/functions/xxhash64.md +25 -0
  198. package/docs/functions/xxhashAsStr.md +29 -0
  199. package/docs/globals.md +329 -0
  200. package/docs/interfaces/AIChatAssistantMessageParam.md +129 -0
  201. package/docs/interfaces/AIChatContentPartImage.md +29 -0
  202. package/docs/interfaces/AIChatContentPartText.md +25 -0
  203. package/docs/interfaces/AIChatMessageParamBase.md +68 -0
  204. package/docs/interfaces/AIChatMessageToolCall.md +41 -0
  205. package/docs/interfaces/AIChatSystemMessageParam.md +105 -0
  206. package/docs/interfaces/AIChatToolChoiceFuncObject.md +37 -0
  207. package/docs/interfaces/AIChatToolChoiceObject.md +25 -0
  208. package/docs/interfaces/AIChatToolFunc.md +41 -0
  209. package/docs/interfaces/AIChatToolFuncParam.md +37 -0
  210. package/docs/interfaces/AIChatToolMessageParam.md +113 -0
  211. package/docs/interfaces/AIChatToolParam.md +25 -0
  212. package/docs/interfaces/AIChatToolTypeObject.md +17 -0
  213. package/docs/interfaces/AIChatUserMessageParam.md +137 -0
  214. package/docs/interfaces/AIChoiceConfig.md +65 -0
  215. package/docs/interfaces/AIResult.md +65 -0
  216. package/docs/interfaces/AIStreamParser.md +43 -0
  217. package/docs/interfaces/AIStreamParserOptions.md +21 -0
  218. package/docs/interfaces/BaseFunc.md +145 -0
  219. package/docs/interfaces/BaseFuncItem.md +93 -0
  220. package/docs/interfaces/BinarySemaphoreAcquireOptions.md +25 -0
  221. package/docs/interfaces/BinarySemaphoreOptions.md +57 -0
  222. package/docs/interfaces/BinarySemaphoreReleaseOptions.md +25 -0
  223. package/docs/interfaces/BinarySemaphoreReleaserFunc.md +37 -0
  224. package/docs/interfaces/CancelableAbilityOptions.md +113 -0
  225. package/docs/interfaces/ClientFuncItem.md +163 -0
  226. package/docs/interfaces/DotenvExpandOptions.md +43 -0
  227. package/docs/interfaces/DotenvExpandOutput.md +25 -0
  228. package/docs/interfaces/DotenvParseInput.md +13 -0
  229. package/docs/interfaces/DotenvParseOutput.md +13 -0
  230. package/docs/interfaces/DotenvPopulateInput.md +13 -0
  231. package/docs/interfaces/EventClientFuncParams.md +51 -0
  232. package/docs/interfaces/EventServerFuncParams.md +67 -0
  233. package/docs/interfaces/FewShotPromptTemplateOptions.md +147 -0
  234. package/docs/interfaces/FuncItem.md +131 -0
  235. package/docs/interfaces/FuncParam.md +61 -0
  236. package/docs/interfaces/FuncParams.md +13 -0
  237. package/docs/interfaces/Funcs.md +13 -0
  238. package/docs/interfaces/HashAlgoParams.md +33 -0
  239. package/docs/interfaces/IFileMetaInfo.md +65 -0
  240. package/docs/interfaces/IReadTextFileChunksOptions.md +143 -0
  241. package/docs/interfaces/ITruncateToTokenLimitOptions.md +99 -0
  242. package/docs/interfaces/JsonFilter.md +13 -0
  243. package/docs/interfaces/ParseObjectArgumentOptions.md +89 -0
  244. package/docs/interfaces/PromptExampleSelectorOptions.md +34 -0
  245. package/docs/interfaces/PromptTemplateOptions.md +65 -0
  246. package/docs/interfaces/RemoteFuncItem.md +152 -0
  247. package/docs/interfaces/ReplacePlacehoderOptions.md +41 -0
  248. package/docs/interfaces/ResClientFuncParams.md +37 -0
  249. package/docs/interfaces/ResServerFuncParams.md +69 -0
  250. package/docs/interfaces/SanitizeFilenameOptions.md +25 -0
  251. package/docs/interfaces/SectionStringOptions.md +25 -0
  252. package/docs/interfaces/SemaphoreOptions.md +89 -0
  253. package/docs/interfaces/SemaphoreTaskItem.md +73 -0
  254. package/docs/interfaces/ServerFuncItem.md +171 -0
  255. package/docs/interfaces/ServerFuncParams.md +35 -0
  256. package/docs/interfaces/SplitSentenceOptions.md +41 -0
  257. package/docs/interfaces/StreamCallbacksAndOptions.md +99 -0
  258. package/docs/interfaces/TaskAbortControllers.md +13 -0
  259. package/docs/interfaces/TaskPromise.md +138 -0
  260. package/docs/interfaces/ToolFuncPackage.md +47 -0
  261. package/docs/namespaces/EventStates/README.md +14 -0
  262. package/docs/namespaces/EventStates/variables/ABORT.md +11 -0
  263. package/docs/namespaces/EventStates/variables/CONTINUE.md +11 -0
  264. package/docs/namespaces/EventStates/variables/DONE.md +11 -0
  265. package/docs/namespaces/EventStates/variables/STOPPED.md +11 -0
  266. package/docs/namespaces/uuidv5/README.md +12 -0
  267. package/docs/namespaces/uuidv5/variables/DNS.md +11 -0
  268. package/docs/namespaces/uuidv5/variables/URL.md +11 -0
  269. package/docs/type-aliases/AIChatContentPart.md +11 -0
  270. package/docs/type-aliases/AIChatMessageParam.md +11 -0
  271. package/docs/type-aliases/AIChatRole.md +11 -0
  272. package/docs/type-aliases/AIChatToolChoiceParam.md +11 -0
  273. package/docs/type-aliases/AIMessageType.md +11 -0
  274. package/docs/type-aliases/AIModelNameRule.md +11 -0
  275. package/docs/type-aliases/AIModelNameRuleFn.md +21 -0
  276. package/docs/type-aliases/AIModelNameRules.md +11 -0
  277. package/docs/type-aliases/AITextGenerationFinishReason.md +11 -0
  278. package/docs/type-aliases/ActionName.md +11 -0
  279. package/docs/type-aliases/AsyncTaskId.md +11 -0
  280. package/docs/type-aliases/BeforeShutdownListener.md +23 -0
  281. package/docs/type-aliases/EventErrorListenerFn.md +33 -0
  282. package/docs/type-aliases/EventListenerFn.md +29 -0
  283. package/docs/type-aliases/FStringPromptTemplateNode.md +14 -0
  284. package/docs/type-aliases/FuncParamType.md +11 -0
  285. package/docs/type-aliases/PromptExamples.md +15 -0
  286. package/docs/type-aliases/PromptTemplateType.md +11 -0
  287. package/docs/type-aliases/PromptType.md +11 -0
  288. package/docs/type-aliases/SemaphoreIsReadyFuncType.md +15 -0
  289. package/docs/type-aliases/TFunc.md +25 -0
  290. package/docs/variables/AIChatRoles.md +11 -0
  291. package/docs/variables/AIMessageTypes.md +11 -0
  292. package/docs/variables/AITextGenerationFinishReasons.md +11 -0
  293. package/docs/variables/AbortErrorCode.md +11 -0
  294. package/docs/variables/ActionNames.md +11 -0
  295. package/docs/variables/AlreadyExistsErrorCode.md +11 -0
  296. package/docs/variables/ClientToolFuncSchema.md +101 -0
  297. package/docs/variables/DEFAULT_CONFIG_NAME.md +11 -0
  298. package/docs/variables/DefaultAsyncSemaphoreCapacity.md +11 -0
  299. package/docs/variables/EventBusName.md +11 -0
  300. package/docs/variables/EventName.md +11 -0
  301. package/docs/variables/FilenameReservedRegex.md +14 -0
  302. package/docs/variables/HFBuiltins.md +122 -0
  303. package/docs/variables/InternalErrorCode.md +11 -0
  304. package/docs/variables/LLM_TOKENIZER_NAMES.md +81 -0
  305. package/docs/variables/LLM_TOKENIZER_NAMES_MAP.md +11 -0
  306. package/docs/variables/NotFoundErrorCode.md +11 -0
  307. package/docs/variables/NotImplementedErrorCode.md +11 -0
  308. package/docs/variables/PASSING_SCORE.md +11 -0
  309. package/docs/variables/PromptTemplateTypes.md +11 -0
  310. package/docs/variables/PromptTypes.md +14 -0
  311. package/docs/variables/RStreamErrCode.md +11 -0
  312. package/docs/variables/RemoteToolFuncSchema.md +101 -0
  313. package/docs/variables/ResponseRStreamErrCode.md +11 -0
  314. package/docs/variables/SHUTDOWN_SIGNALS.md +17 -0
  315. package/docs/variables/SSEChannelAlreadyClosedErrCode.md +11 -0
  316. package/docs/variables/SecondaryCache.md +11 -0
  317. package/docs/variables/ServerToolFuncSchema.md +101 -0
  318. package/docs/variables/ToolAsyncCancelableBit.md +11 -0
  319. package/docs/variables/ToolAsyncMultiTaskBit.md +11 -0
  320. package/docs/variables/ToolAsyncPriorityBit.md +11 -0
  321. package/docs/variables/ToolFuncSchema.md +133 -0
  322. package/docs/variables/WindowsReservedNameRegex.md +13 -0
  323. package/docs/variables/base32768.md +11 -0
  324. package/docs/variables/defaultTemplateFormat.md +11 -0
  325. package/docs/variables/event.md +11 -0
  326. package/docs/variables/eventClient.md +11 -0
  327. package/docs/variables/eventServer.md +11 -0
  328. package/docs/variables/lrucache.md +11 -0
  329. package/docs/variables/mimeType.md +11 -0
  330. package/docs/variables/uuidNIL.md +11 -0
  331. package/package.json +2 -2
@@ -0,0 +1,2431 @@
1
+ [**@isdk/ai-tool**](../README.md)
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / ResClientTools
6
+
7
+ # Class: ResClientTools
8
+
9
+ Defined in: [packages/ai-tool/src/res-client-tools.ts:9](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/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: [packages/ai-tool/src/tool-func.ts:192](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L192)
30
+
31
+ #### Parameters
32
+
33
+ ##### name
34
+
35
+ `string` | `Function` | [`FuncItem`](../interfaces/FuncItem.md)
36
+
37
+ ##### options
38
+
39
+ `any` = `{}`
40
+
41
+ #### Returns
42
+
43
+ [`ResClientTools`](ResClientTools.md)
44
+
45
+ ## Properties
46
+
47
+ ### $attributes
48
+
49
+ > **$attributes**: `Properties`
50
+
51
+ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/advance.d.ts:5
52
+
53
+ ***
54
+
55
+ ### action?
56
+
57
+ > `optional` **action**: `"get"` \| `"post"` \| `"put"` \| `"delete"` \| `"patch"` \| `"list"` \| `"res"`
58
+
59
+ Defined in: [packages/ai-tool/src/utils/consts.ts:35](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/consts.ts#L35)
60
+
61
+ ***
62
+
63
+ ### apiRoot
64
+
65
+ > **apiRoot**: `undefined` \| `string`
66
+
67
+ Defined in: [packages/ai-tool/src/client-tools.ts:16](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/client-tools.ts#L16)
68
+
69
+ ***
70
+
71
+ ### constructor
72
+
73
+ > **constructor**: `Function`
74
+
75
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:125
76
+
77
+ The initial value of Object.prototype.constructor is the standard built-in Object constructor.
78
+
79
+ ***
80
+
81
+ ### defaultOptions
82
+
83
+ > **defaultOptions**: `object`
84
+
85
+ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:74
86
+
87
+ The default options for export and assign
88
+
89
+ #### assign?
90
+
91
+ > `optional` **assign**: `IMergeOptions`
92
+
93
+ #### export?
94
+
95
+ > `optional` **export**: `IMergeOptions`
96
+
97
+ ***
98
+
99
+ ### fetchOptions?
100
+
101
+ > `optional` **fetchOptions**: `any`
102
+
103
+ Defined in: [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/consts.ts#L36)
104
+
105
+ ***
106
+
107
+ ### isApi?
108
+
109
+ > `optional` **isApi**: `boolean`
110
+
111
+ Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L29)
112
+
113
+ ***
114
+
115
+ ### name?
116
+
117
+ > `optional` **name**: `string`
118
+
119
+ Defined in: [packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L23)
120
+
121
+ ***
122
+
123
+ ### nonExported1stChar
124
+
125
+ > **nonExported1stChar**: `string`
126
+
127
+ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:78
128
+
129
+ the property with the default prefix '$' will not be exported.
130
+
131
+ ***
132
+
133
+ ### params?
134
+
135
+ > `optional` **params**: [`FuncParams`](../interfaces/FuncParams.md) \| [`FuncParam`](../interfaces/FuncParam.md)[]
136
+
137
+ Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L24)
138
+
139
+ ***
140
+
141
+ ### result?
142
+
143
+ > `optional` **result**: `string`
144
+
145
+ Defined in: [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L25)
146
+
147
+ ***
148
+
149
+ ### scope?
150
+
151
+ > `optional` **scope**: `any`
152
+
153
+ Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L26)
154
+
155
+ ***
156
+
157
+ ### setup()?
158
+
159
+ > `optional` **setup**: (`this`, `options`?) => `void`
160
+
161
+ Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L28)
162
+
163
+ #### Parameters
164
+
165
+ ##### this
166
+
167
+ [`ToolFunc`](ToolFunc.md)
168
+
169
+ ##### options?
170
+
171
+ [`FuncItem`](../interfaces/FuncItem.md)
172
+
173
+ #### Returns
174
+
175
+ `void`
176
+
177
+ ***
178
+
179
+ ### stream?
180
+
181
+ > `optional` **stream**: `boolean`
182
+
183
+ Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L30)
184
+
185
+ ***
186
+
187
+ ### tags?
188
+
189
+ > `optional` **tags**: `string` \| `string`[]
190
+
191
+ Defined in: [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L27)
192
+
193
+ ***
194
+
195
+ ### dataPath
196
+
197
+ > `static` **dataPath**: `string`
198
+
199
+ Defined in: [packages/ai-tool/src/tool-func.ts:57](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L57)
200
+
201
+ ***
202
+
203
+ ### items
204
+
205
+ > `static` **items**: [`Funcs`](../interfaces/Funcs.md) = `{}`
206
+
207
+ Defined in: [packages/ai-tool/src/tool-func.ts:56](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L56)
208
+
209
+ ## Accessors
210
+
211
+ ### apiRoot
212
+
213
+ #### Get Signature
214
+
215
+ > **get** `static` **apiRoot**(): `undefined` \| `string`
216
+
217
+ Defined in: [packages/ai-tool/src/client-tools.ts:19](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/client-tools.ts#L19)
218
+
219
+ ##### Returns
220
+
221
+ `undefined` \| `string`
222
+
223
+ ## Methods
224
+
225
+ ### \_func()
226
+
227
+ > **\_func**(`action`, `options`): `Promise`\<`any`\>
228
+
229
+ Defined in: [packages/ai-tool/src/rpc-methods-client-tool.ts:10](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/rpc-methods-client-tool.ts#L10)
230
+
231
+ #### Parameters
232
+
233
+ ##### action
234
+
235
+ `"get"` | `"post"` | `"put"` | `"delete"` | `"patch"` | `"list"` | `"res"`
236
+
237
+ ##### options
238
+
239
+ `RpcMethodsClientFuncParams`
240
+
241
+ #### Returns
242
+
243
+ `Promise`\<`any`\>
244
+
245
+ ***
246
+
247
+ ### arr2ObjParams()
248
+
249
+ > **arr2ObjParams**(`params`): `any`[]
250
+
251
+ Defined in: [packages/ai-tool/src/tool-func.ts:236](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L236)
252
+
253
+ #### Parameters
254
+
255
+ ##### params
256
+
257
+ `any`[]
258
+
259
+ #### Returns
260
+
261
+ `any`[]
262
+
263
+ ***
264
+
265
+ ### assign()
266
+
267
+ > **assign**(`src`, `options`?): `this`
268
+
269
+ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:106
270
+
271
+ Assign the values from the src object.
272
+
273
+ #### Parameters
274
+
275
+ ##### src
276
+
277
+ `any`
278
+
279
+ the source object
280
+
281
+ ##### options?
282
+
283
+ `IMergeOptions`
284
+
285
+ #### Returns
286
+
287
+ `this`
288
+
289
+ this object
290
+
291
+ ***
292
+
293
+ ### assignMethods()
294
+
295
+ > **assignMethods**(`methods`): `void`
296
+
297
+ Defined in: [packages/ai-tool/src/rpc-methods-client-tool.ts:27](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/rpc-methods-client-tool.ts#L27)
298
+
299
+ #### Parameters
300
+
301
+ ##### methods
302
+
303
+ `string`[]
304
+
305
+ #### Returns
306
+
307
+ `void`
308
+
309
+ ***
310
+
311
+ ### assignProperty()
312
+
313
+ > **assignProperty**(`src`, `name`, `value`, `attrs`?, `options`?): `void`
314
+
315
+ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:117
316
+
317
+ Assign a property of src to this object.
318
+
319
+ #### Parameters
320
+
321
+ ##### src
322
+
323
+ `any`
324
+
325
+ the src object
326
+
327
+ ##### name
328
+
329
+ `string`
330
+
331
+ the property name to assign
332
+
333
+ ##### value
334
+
335
+ `any`
336
+
337
+ the property value to assign
338
+
339
+ ##### attrs?
340
+
341
+ `any`
342
+
343
+ the attributes object
344
+
345
+ ##### options?
346
+
347
+ `IMergeOptions`
348
+
349
+ #### Returns
350
+
351
+ `void`
352
+
353
+ ***
354
+
355
+ ### assignPropertyTo()
356
+
357
+ > `abstract` **assignPropertyTo**(`dest`, `src`, `name`, `value`, `attrs`?, `options`?): `void`
358
+
359
+ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:131
360
+
361
+ Assign the property value from the src to destination object.
362
+
363
+ #### Parameters
364
+
365
+ ##### dest
366
+
367
+ `any`
368
+
369
+ The destination object
370
+
371
+ ##### src
372
+
373
+ `any`
374
+
375
+ The src object
376
+
377
+ ##### name
378
+
379
+ `string`
380
+
381
+ The property name
382
+
383
+ ##### value
384
+
385
+ `any`
386
+
387
+ The property value
388
+
389
+ ##### attrs?
390
+
391
+ `any`
392
+
393
+ The attributes object of the property
394
+
395
+ ##### options?
396
+
397
+ `IMergeOptions`
398
+
399
+ #### Returns
400
+
401
+ `void`
402
+
403
+ ***
404
+
405
+ ### assignTo()
406
+
407
+ > **assignTo**(`dest`?, `options`?): `any`
408
+
409
+ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:191
410
+
411
+ Assign this attributes to the dest object
412
+
413
+ #### Parameters
414
+
415
+ ##### dest?
416
+
417
+ `any`
418
+
419
+ the destination object
420
+
421
+ ##### options?
422
+
423
+ `IMergeOptions`
424
+
425
+ #### Returns
426
+
427
+ `any`
428
+
429
+ the dest object
430
+
431
+ ***
432
+
433
+ ### clone()
434
+
435
+ > **clone**(`options`?): `any`
436
+
437
+ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:155
438
+
439
+ Create a new object with the same values of attributes.
440
+
441
+ #### Parameters
442
+
443
+ ##### options?
444
+
445
+ `IMergeOptions`
446
+
447
+ #### Returns
448
+
449
+ `any`
450
+
451
+ the new object
452
+
453
+ ***
454
+
455
+ ### cloneTo()
456
+
457
+ > **cloneTo**(`dest`, `options`?): `any`
458
+
459
+ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:148
460
+
461
+ Create and assign the values to the destination object.
462
+
463
+ #### Parameters
464
+
465
+ ##### dest
466
+
467
+ `any`
468
+
469
+ the destination object
470
+
471
+ ##### options?
472
+
473
+ `IMergeOptions`
474
+
475
+ #### Returns
476
+
477
+ `any`
478
+
479
+ the new dest object
480
+
481
+ ***
482
+
483
+ ### defineProperties()
484
+
485
+ > `abstract` **defineProperties**(`aProperties`): `any`
486
+
487
+ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:89
488
+
489
+ Define the attributes of this object.
490
+
491
+ #### Parameters
492
+
493
+ ##### aProperties
494
+
495
+ `SimplePropDescriptors`
496
+
497
+ the defined attributes of the object
498
+
499
+ #### Returns
500
+
501
+ `any`
502
+
503
+ ***
504
+
505
+ ### delete()?
506
+
507
+ > `optional` **delete**(`__namedParameters`): `any`
508
+
509
+ Defined in: [packages/ai-tool/src/res-client-tools.ts:13](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/res-client-tools.ts#L13)
510
+
511
+ #### Parameters
512
+
513
+ ##### \_\_namedParameters
514
+
515
+ [`ResClientFuncParams`](../interfaces/ResClientFuncParams.md)
516
+
517
+ #### Returns
518
+
519
+ `any`
520
+
521
+ ***
522
+
523
+ ### errorFrom()
524
+
525
+ > **errorFrom**(`res`): `Promise`\<[`CommonError`](CommonError.md)\>
526
+
527
+ Defined in: [packages/ai-tool/src/client-tools.ts:118](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/client-tools.ts#L118)
528
+
529
+ #### Parameters
530
+
531
+ ##### res
532
+
533
+ `Response`
534
+
535
+ #### Returns
536
+
537
+ `Promise`\<[`CommonError`](CommonError.md)\>
538
+
539
+ ***
540
+
541
+ ### exportTo()
542
+
543
+ > **exportTo**(`dest`, `options`?): `any`
544
+
545
+ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:173
546
+
547
+ Export attributes to the dest json object.
548
+
549
+ #### Parameters
550
+
551
+ ##### dest
552
+
553
+ `any`
554
+
555
+ the destination object
556
+
557
+ ##### options?
558
+
559
+ `IExportOptions`
560
+
561
+ #### Returns
562
+
563
+ `any`
564
+
565
+ the dest object.
566
+
567
+ ***
568
+
569
+ ### fetch()
570
+
571
+ > **fetch**(`options`, `action`): `Promise`\<`Response`\>
572
+
573
+ Defined in: [packages/ai-tool/src/res-client-tools.ts:18](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/res-client-tools.ts#L18)
574
+
575
+ #### Parameters
576
+
577
+ ##### options
578
+
579
+ [`ResClientFuncParams`](../interfaces/ResClientFuncParams.md)
580
+
581
+ ##### action
582
+
583
+ `"get"` | `"post"` | `"put"` | `"delete"` | `"patch"` | `"list"` | `"res"`
584
+
585
+ #### Returns
586
+
587
+ `Promise`\<`Response`\>
588
+
589
+ ***
590
+
591
+ ### func()
592
+
593
+ > **func**(`options`): `Promise`\<`any`\>
594
+
595
+ Defined in: [packages/ai-tool/src/rpc-methods-client-tool.ts:19](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/rpc-methods-client-tool.ts#L19)
596
+
597
+ #### Parameters
598
+
599
+ ##### options
600
+
601
+ `RpcMethodsClientFuncParams`
602
+
603
+ #### Returns
604
+
605
+ `Promise`\<`any`\>
606
+
607
+ ***
608
+
609
+ ### get()?
610
+
611
+ > `optional` **get**(`__namedParameters`): `any`
612
+
613
+ Defined in: [packages/ai-tool/src/res-client-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/res-client-tools.ts#L10)
614
+
615
+ #### Parameters
616
+
617
+ ##### \_\_namedParameters
618
+
619
+ [`ResClientFuncParams`](../interfaces/ResClientFuncParams.md)
620
+
621
+ #### Returns
622
+
623
+ `any`
624
+
625
+ ***
626
+
627
+ ### getFunc()
628
+
629
+ > **getFunc**(`name`?): `any`
630
+
631
+ Defined in: [packages/ai-tool/src/tool-func.ts:289](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L289)
632
+
633
+ #### Parameters
634
+
635
+ ##### name?
636
+
637
+ `string`
638
+
639
+ #### Returns
640
+
641
+ `any`
642
+
643
+ ***
644
+
645
+ ### getFuncWithPos()
646
+
647
+ > **getFuncWithPos**(`name`?): `any`
648
+
649
+ Defined in: [packages/ai-tool/src/tool-func.ts:313](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L313)
650
+
651
+ #### Parameters
652
+
653
+ ##### name?
654
+
655
+ `string`
656
+
657
+ #### Returns
658
+
659
+ `any`
660
+
661
+ ***
662
+
663
+ ### getProperties()
664
+
665
+ > `abstract` **getProperties**(): `PropDescriptors`
666
+
667
+ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:98
668
+
669
+ Get the defined attributes.
670
+
671
+ #### Returns
672
+
673
+ `PropDescriptors`
674
+
675
+ the descriptors of properties object
676
+
677
+ ***
678
+
679
+ ### getUrlParams()
680
+
681
+ > **getUrlParams**(`objParam`): `string`
682
+
683
+ Defined in: [packages/ai-tool/src/client-tools.ts:63](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/client-tools.ts#L63)
684
+
685
+ #### Parameters
686
+
687
+ ##### objParam
688
+
689
+ `any`
690
+
691
+ #### Returns
692
+
693
+ `string`
694
+
695
+ ***
696
+
697
+ ### hasAsyncFeature()
698
+
699
+ > **hasAsyncFeature**(`feature`): `boolean`
700
+
701
+ Defined in: [packages/ai-tool/src/tool-func.ts:318](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L318)
702
+
703
+ #### Parameters
704
+
705
+ ##### feature
706
+
707
+ [`AsyncFeatureBits`](../enumerations/AsyncFeatureBits.md)
708
+
709
+ #### Returns
710
+
711
+ `boolean`
712
+
713
+ ***
714
+
715
+ ### hasOwnProperty()
716
+
717
+ > **hasOwnProperty**(`v`): `boolean`
718
+
719
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:140
720
+
721
+ Determines whether an object has a property with the specified name.
722
+
723
+ #### Parameters
724
+
725
+ ##### v
726
+
727
+ `PropertyKey`
728
+
729
+ A property name.
730
+
731
+ #### Returns
732
+
733
+ `boolean`
734
+
735
+ ***
736
+
737
+ ### initialize()
738
+
739
+ > **initialize**(`src`?): `this`
740
+
741
+ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:139
742
+
743
+ Initialize object and assign attribute values from src if src exists.
744
+
745
+ #### Parameters
746
+
747
+ ##### src?
748
+
749
+ `any`
750
+
751
+ #### Returns
752
+
753
+ `this`
754
+
755
+ this object.
756
+
757
+ ***
758
+
759
+ ### isPrototypeOf()
760
+
761
+ > **isPrototypeOf**(`v`): `boolean`
762
+
763
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:146
764
+
765
+ Determines whether an object exists in another object's prototype chain.
766
+
767
+ #### Parameters
768
+
769
+ ##### v
770
+
771
+ `Object`
772
+
773
+ Another object whose prototype chain is to be checked.
774
+
775
+ #### Returns
776
+
777
+ `boolean`
778
+
779
+ ***
780
+
781
+ ### isSame()
782
+
783
+ > **isSame**(`src`, `options`?): `boolean`
784
+
785
+ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:200
786
+
787
+ Check the src object whether “equals” this object.
788
+
789
+ #### Parameters
790
+
791
+ ##### src
792
+
793
+ `any`
794
+
795
+ The source object
796
+
797
+ ##### options?
798
+
799
+ `IMergeOptions`
800
+
801
+ #### Returns
802
+
803
+ `boolean`
804
+
805
+ ***
806
+
807
+ ### isStream()
808
+
809
+ > **isStream**(`params`): `undefined` \| `boolean`
810
+
811
+ Defined in: [packages/ai-tool/src/tool-func.ts:324](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L324)
812
+
813
+ #### Parameters
814
+
815
+ ##### params
816
+
817
+ `any`
818
+
819
+ #### Returns
820
+
821
+ `undefined` \| `boolean`
822
+
823
+ ***
824
+
825
+ ### list()?
826
+
827
+ > `optional` **list**(`options`): `any`
828
+
829
+ Defined in: [packages/ai-tool/src/res-client-tools.ts:14](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/res-client-tools.ts#L14)
830
+
831
+ #### Parameters
832
+
833
+ ##### options
834
+
835
+ [`ResClientFuncParams`](../interfaces/ResClientFuncParams.md)
836
+
837
+ #### Returns
838
+
839
+ `any`
840
+
841
+ ***
842
+
843
+ ### mergeTo()
844
+
845
+ > **mergeTo**(`dest`, `options`?): `any`
846
+
847
+ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:164
848
+
849
+ Merge this attributes to dest object.
850
+
851
+ #### Parameters
852
+
853
+ ##### dest
854
+
855
+ `any`
856
+
857
+ The destination object
858
+
859
+ ##### options?
860
+
861
+ `IMergeOptions`
862
+
863
+ #### Returns
864
+
865
+ `any`
866
+
867
+ the dest object.
868
+
869
+ ***
870
+
871
+ ### obj2ArrParams()
872
+
873
+ > **obj2ArrParams**(`params`?): `any`[]
874
+
875
+ Defined in: [packages/ai-tool/src/tool-func.ts:249](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L249)
876
+
877
+ #### Parameters
878
+
879
+ ##### params?
880
+
881
+ `any`
882
+
883
+ #### Returns
884
+
885
+ `any`[]
886
+
887
+ ***
888
+
889
+ ### post()?
890
+
891
+ > `optional` **post**(`options`): `any`
892
+
893
+ Defined in: [packages/ai-tool/src/res-client-tools.ts:11](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/res-client-tools.ts#L11)
894
+
895
+ #### Parameters
896
+
897
+ ##### options
898
+
899
+ [`ResClientFuncParams`](../interfaces/ResClientFuncParams.md)
900
+
901
+ #### Returns
902
+
903
+ `any`
904
+
905
+ ***
906
+
907
+ ### propertyIsEnumerable()
908
+
909
+ > **propertyIsEnumerable**(`v`): `boolean`
910
+
911
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:152
912
+
913
+ Determines whether a specified property is enumerable.
914
+
915
+ #### Parameters
916
+
917
+ ##### v
918
+
919
+ `PropertyKey`
920
+
921
+ A property name.
922
+
923
+ #### Returns
924
+
925
+ `boolean`
926
+
927
+ ***
928
+
929
+ ### put()?
930
+
931
+ > `optional` **put**(`__namedParameters`): `any`
932
+
933
+ Defined in: [packages/ai-tool/src/res-client-tools.ts:12](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/res-client-tools.ts#L12)
934
+
935
+ #### Parameters
936
+
937
+ ##### \_\_namedParameters
938
+
939
+ [`ResClientFuncParams`](../interfaces/ResClientFuncParams.md)
940
+
941
+ #### Returns
942
+
943
+ `any`
944
+
945
+ ***
946
+
947
+ ### register()
948
+
949
+ > **register**(): `boolean` \| [`ToolFunc`](ToolFunc.md)
950
+
951
+ Defined in: [packages/ai-tool/src/tool-func.ts:219](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L219)
952
+
953
+ #### Returns
954
+
955
+ `boolean` \| [`ToolFunc`](ToolFunc.md)
956
+
957
+ ***
958
+
959
+ ### run()
960
+
961
+ > **run**(`params`?): `Promise`\<`any`\>
962
+
963
+ Defined in: [packages/ai-tool/src/tool-func.ts:276](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L276)
964
+
965
+ #### Parameters
966
+
967
+ ##### params?
968
+
969
+ `any`
970
+
971
+ #### Returns
972
+
973
+ `Promise`\<`any`\>
974
+
975
+ ***
976
+
977
+ ### runAs()
978
+
979
+ > **runAs**(`name`, `params`?): `Promise`\<`any`\>
980
+
981
+ Defined in: [packages/ai-tool/src/tool-func.ts:280](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L280)
982
+
983
+ #### Parameters
984
+
985
+ ##### name
986
+
987
+ `string`
988
+
989
+ ##### params?
990
+
991
+ `any`
992
+
993
+ #### Returns
994
+
995
+ `Promise`\<`any`\>
996
+
997
+ ***
998
+
999
+ ### runAsSync()
1000
+
1001
+ > **runAsSync**(`name`, `params`?): `any`
1002
+
1003
+ Defined in: [packages/ai-tool/src/tool-func.ts:284](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L284)
1004
+
1005
+ #### Parameters
1006
+
1007
+ ##### name
1008
+
1009
+ `string`
1010
+
1011
+ ##### params?
1012
+
1013
+ `any`
1014
+
1015
+ #### Returns
1016
+
1017
+ `any`
1018
+
1019
+ ***
1020
+
1021
+ ### runSync()
1022
+
1023
+ > **runSync**(`params`?): `any`
1024
+
1025
+ Defined in: [packages/ai-tool/src/tool-func.ts:262](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L262)
1026
+
1027
+ #### Parameters
1028
+
1029
+ ##### params?
1030
+
1031
+ `any`
1032
+
1033
+ #### Returns
1034
+
1035
+ `any`
1036
+
1037
+ ***
1038
+
1039
+ ### runWithPos()
1040
+
1041
+ > **runWithPos**(...`params`): `Promise`\<`any`\>
1042
+
1043
+ Defined in: [packages/ai-tool/src/tool-func.ts:305](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L305)
1044
+
1045
+ #### Parameters
1046
+
1047
+ ##### params
1048
+
1049
+ ...`any`[]
1050
+
1051
+ #### Returns
1052
+
1053
+ `Promise`\<`any`\>
1054
+
1055
+ ***
1056
+
1057
+ ### runWithPosAs()
1058
+
1059
+ > **runWithPosAs**(`name`, ...`params`): `Promise`\<`any`\>
1060
+
1061
+ Defined in: [packages/ai-tool/src/tool-func.ts:309](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L309)
1062
+
1063
+ #### Parameters
1064
+
1065
+ ##### name
1066
+
1067
+ `string`
1068
+
1069
+ ##### params
1070
+
1071
+ ...`any`[]
1072
+
1073
+ #### Returns
1074
+
1075
+ `Promise`\<`any`\>
1076
+
1077
+ ***
1078
+
1079
+ ### runWithPosAsSync()
1080
+
1081
+ > **runWithPosAsSync**(`name`, ...`params`): `any`
1082
+
1083
+ Defined in: [packages/ai-tool/src/tool-func.ts:301](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L301)
1084
+
1085
+ #### Parameters
1086
+
1087
+ ##### name
1088
+
1089
+ `string`
1090
+
1091
+ ##### params
1092
+
1093
+ ...`any`[]
1094
+
1095
+ #### Returns
1096
+
1097
+ `any`
1098
+
1099
+ ***
1100
+
1101
+ ### runWithPosSync()
1102
+
1103
+ > **runWithPosSync**(...`params`): `any`
1104
+
1105
+ Defined in: [packages/ai-tool/src/tool-func.ts:294](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L294)
1106
+
1107
+ #### Parameters
1108
+
1109
+ ##### params
1110
+
1111
+ ...`any`[]
1112
+
1113
+ #### Returns
1114
+
1115
+ `any`
1116
+
1117
+ ***
1118
+
1119
+ ### toJSON()
1120
+
1121
+ > **toJSON**(): `any`
1122
+
1123
+ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:182
1124
+
1125
+ #### Returns
1126
+
1127
+ `any`
1128
+
1129
+ ***
1130
+
1131
+ ### toLocaleString()
1132
+
1133
+ > **toLocaleString**(): `string`
1134
+
1135
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:131
1136
+
1137
+ Returns a date converted to a string using the current locale.
1138
+
1139
+ #### Returns
1140
+
1141
+ `string`
1142
+
1143
+ ***
1144
+
1145
+ ### toObject()
1146
+
1147
+ > **toObject**(`options`?): `any`
1148
+
1149
+ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:181
1150
+
1151
+ Convert the attributes to the json object
1152
+
1153
+ #### Parameters
1154
+
1155
+ ##### options?
1156
+
1157
+ `any`
1158
+
1159
+ #### Returns
1160
+
1161
+ `any`
1162
+
1163
+ the json object.
1164
+
1165
+ ***
1166
+
1167
+ ### toString()
1168
+
1169
+ > **toString**(): `string`
1170
+
1171
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:128
1172
+
1173
+ Returns a string representation of an object.
1174
+
1175
+ #### Returns
1176
+
1177
+ `string`
1178
+
1179
+ ***
1180
+
1181
+ ### unregister()
1182
+
1183
+ > **unregister**(): `any`
1184
+
1185
+ Defined in: [packages/ai-tool/src/tool-func.ts:232](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L232)
1186
+
1187
+ #### Returns
1188
+
1189
+ `any`
1190
+
1191
+ ***
1192
+
1193
+ ### valueOf()
1194
+
1195
+ > **valueOf**(): `Object`
1196
+
1197
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:134
1198
+
1199
+ Returns the primitive value of the specified object.
1200
+
1201
+ #### Returns
1202
+
1203
+ `Object`
1204
+
1205
+ ***
1206
+
1207
+ ### assign()
1208
+
1209
+ #### Call Signature
1210
+
1211
+ > `static` **assign**\<`T`, `U`\>(`target`, `source`): `T` & `U`
1212
+
1213
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:286
1214
+
1215
+ Copy the values of all of the enumerable own properties from one or more source objects to a
1216
+ target object. Returns the target object.
1217
+
1218
+ ##### Type Parameters
1219
+
1220
+ • **T** *extends* `object`
1221
+
1222
+ • **U**
1223
+
1224
+ ##### Parameters
1225
+
1226
+ ###### target
1227
+
1228
+ `T`
1229
+
1230
+ The target object to copy to.
1231
+
1232
+ ###### source
1233
+
1234
+ `U`
1235
+
1236
+ The source object from which to copy properties.
1237
+
1238
+ ##### Returns
1239
+
1240
+ `T` & `U`
1241
+
1242
+ #### Call Signature
1243
+
1244
+ > `static` **assign**\<`T`, `U`, `V`\>(`target`, `source1`, `source2`): `T` & `U` & `V`
1245
+
1246
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:295
1247
+
1248
+ Copy the values of all of the enumerable own properties from one or more source objects to a
1249
+ target object. Returns the target object.
1250
+
1251
+ ##### Type Parameters
1252
+
1253
+ • **T** *extends* `object`
1254
+
1255
+ • **U**
1256
+
1257
+ • **V**
1258
+
1259
+ ##### Parameters
1260
+
1261
+ ###### target
1262
+
1263
+ `T`
1264
+
1265
+ The target object to copy to.
1266
+
1267
+ ###### source1
1268
+
1269
+ `U`
1270
+
1271
+ The first source object from which to copy properties.
1272
+
1273
+ ###### source2
1274
+
1275
+ `V`
1276
+
1277
+ The second source object from which to copy properties.
1278
+
1279
+ ##### Returns
1280
+
1281
+ `T` & `U` & `V`
1282
+
1283
+ #### Call Signature
1284
+
1285
+ > `static` **assign**\<`T`, `U`, `V`, `W`\>(`target`, `source1`, `source2`, `source3`): `T` & `U` & `V` & `W`
1286
+
1287
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:305
1288
+
1289
+ Copy the values of all of the enumerable own properties from one or more source objects to a
1290
+ target object. Returns the target object.
1291
+
1292
+ ##### Type Parameters
1293
+
1294
+ • **T** *extends* `object`
1295
+
1296
+ • **U**
1297
+
1298
+ • **V**
1299
+
1300
+ • **W**
1301
+
1302
+ ##### Parameters
1303
+
1304
+ ###### target
1305
+
1306
+ `T`
1307
+
1308
+ The target object to copy to.
1309
+
1310
+ ###### source1
1311
+
1312
+ `U`
1313
+
1314
+ The first source object from which to copy properties.
1315
+
1316
+ ###### source2
1317
+
1318
+ `V`
1319
+
1320
+ The second source object from which to copy properties.
1321
+
1322
+ ###### source3
1323
+
1324
+ `W`
1325
+
1326
+ The third source object from which to copy properties.
1327
+
1328
+ ##### Returns
1329
+
1330
+ `T` & `U` & `V` & `W`
1331
+
1332
+ #### Call Signature
1333
+
1334
+ > `static` **assign**(`target`, ...`sources`): `any`
1335
+
1336
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:313
1337
+
1338
+ Copy the values of all of the enumerable own properties from one or more source objects to a
1339
+ target object. Returns the target object.
1340
+
1341
+ ##### Parameters
1342
+
1343
+ ###### target
1344
+
1345
+ `object`
1346
+
1347
+ The target object to copy to.
1348
+
1349
+ ###### sources
1350
+
1351
+ ...`any`[]
1352
+
1353
+ One or more source objects from which to copy properties
1354
+
1355
+ ##### Returns
1356
+
1357
+ `any`
1358
+
1359
+ ***
1360
+
1361
+ ### create()
1362
+
1363
+ #### Call Signature
1364
+
1365
+ > `static` **create**(`o`): `any`
1366
+
1367
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:188
1368
+
1369
+ Creates an object that has the specified prototype or that has null prototype.
1370
+
1371
+ ##### Parameters
1372
+
1373
+ ###### o
1374
+
1375
+ Object to use as a prototype. May be null.
1376
+
1377
+ `null` | `object`
1378
+
1379
+ ##### Returns
1380
+
1381
+ `any`
1382
+
1383
+ #### Call Signature
1384
+
1385
+ > `static` **create**(`o`, `properties`): `any`
1386
+
1387
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:195
1388
+
1389
+ Creates an object that has the specified prototype, and that optionally contains specified properties.
1390
+
1391
+ ##### Parameters
1392
+
1393
+ ###### o
1394
+
1395
+ Object to use as a prototype. May be null
1396
+
1397
+ `null` | `object`
1398
+
1399
+ ###### properties
1400
+
1401
+ `PropertyDescriptorMap` & `ThisType`\<`any`\>
1402
+
1403
+ JavaScript object that contains one or more property descriptors.
1404
+
1405
+ ##### Returns
1406
+
1407
+ `any`
1408
+
1409
+ ***
1410
+
1411
+ ### defineProperties()
1412
+
1413
+ > `static` **defineProperties**(`aTarget`, `aProperties`, `recreate`?): `any`
1414
+
1415
+ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/advance.d.ts:11
1416
+
1417
+ Adds one or more properties to an object, and/or modifies attributes of existing properties.
1418
+
1419
+ #### Parameters
1420
+
1421
+ ##### aTarget
1422
+
1423
+ `any`
1424
+
1425
+ ##### aProperties
1426
+
1427
+ `PropDescriptors`
1428
+
1429
+ ##### recreate?
1430
+
1431
+ `boolean`
1432
+
1433
+ #### Returns
1434
+
1435
+ `any`
1436
+
1437
+ ***
1438
+
1439
+ ### defineProperty()
1440
+
1441
+ > `static` **defineProperty**\<`T`\>(`o`, `p`, `attributes`): `T`
1442
+
1443
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:203
1444
+
1445
+ Adds a property to an object, or modifies attributes of an existing property.
1446
+
1447
+ #### Type Parameters
1448
+
1449
+ • **T**
1450
+
1451
+ #### Parameters
1452
+
1453
+ ##### o
1454
+
1455
+ `T`
1456
+
1457
+ 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.
1458
+
1459
+ ##### p
1460
+
1461
+ `PropertyKey`
1462
+
1463
+ The property name.
1464
+
1465
+ ##### attributes
1466
+
1467
+ `PropertyDescriptor` & `ThisType`\<`any`\>
1468
+
1469
+ Descriptor for the property. It can be for a data property or an accessor property.
1470
+
1471
+ #### Returns
1472
+
1473
+ `T`
1474
+
1475
+ ***
1476
+
1477
+ ### entries()
1478
+
1479
+ #### Call Signature
1480
+
1481
+ > `static` **entries**\<`T`\>(`o`): \[`string`, `T`\][]
1482
+
1483
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2017.object.d.ts:36
1484
+
1485
+ Returns an array of key/values of the enumerable own properties of an object
1486
+
1487
+ ##### Type Parameters
1488
+
1489
+ • **T**
1490
+
1491
+ ##### Parameters
1492
+
1493
+ ###### o
1494
+
1495
+ Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.
1496
+
1497
+ \{\} | `ArrayLike`\<`T`\>
1498
+
1499
+ ##### Returns
1500
+
1501
+ \[`string`, `T`\][]
1502
+
1503
+ #### Call Signature
1504
+
1505
+ > `static` **entries**(`o`): \[`string`, `any`\][]
1506
+
1507
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2017.object.d.ts:42
1508
+
1509
+ Returns an array of key/values of the enumerable own properties of an object
1510
+
1511
+ ##### Parameters
1512
+
1513
+ ###### o
1514
+
1515
+ Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.
1516
+
1517
+ ##### Returns
1518
+
1519
+ \[`string`, `any`\][]
1520
+
1521
+ ***
1522
+
1523
+ ### fetch()
1524
+
1525
+ > `static` **fetch**(`name`, `objParam`?): `Promise`\<`any`\>
1526
+
1527
+ Defined in: [packages/ai-tool/src/client-tools.ts:56](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/client-tools.ts#L56)
1528
+
1529
+ #### Parameters
1530
+
1531
+ ##### name
1532
+
1533
+ `string`
1534
+
1535
+ ##### objParam?
1536
+
1537
+ `any`
1538
+
1539
+ #### Returns
1540
+
1541
+ `Promise`\<`any`\>
1542
+
1543
+ ***
1544
+
1545
+ ### freeze()
1546
+
1547
+ #### Call Signature
1548
+
1549
+ > `static` **freeze**\<`T`\>(`f`): `T`
1550
+
1551
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:222
1552
+
1553
+ Prevents the modification of existing property attributes and values, and prevents the addition of new properties.
1554
+
1555
+ ##### Type Parameters
1556
+
1557
+ • **T** *extends* `Function`
1558
+
1559
+ ##### Parameters
1560
+
1561
+ ###### f
1562
+
1563
+ `T`
1564
+
1565
+ Object on which to lock the attributes.
1566
+
1567
+ ##### Returns
1568
+
1569
+ `T`
1570
+
1571
+ #### Call Signature
1572
+
1573
+ > `static` **freeze**\<`T`, `U`\>(`o`): `Readonly`\<`T`\>
1574
+
1575
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:228
1576
+
1577
+ Prevents the modification of existing property attributes and values, and prevents the addition of new properties.
1578
+
1579
+ ##### Type Parameters
1580
+
1581
+ • **T** *extends* `object`
1582
+
1583
+ • **U** *extends* `string` \| `number` \| `bigint` \| `boolean` \| `symbol`
1584
+
1585
+ ##### Parameters
1586
+
1587
+ ###### o
1588
+
1589
+ `T`
1590
+
1591
+ Object on which to lock the attributes.
1592
+
1593
+ ##### Returns
1594
+
1595
+ `Readonly`\<`T`\>
1596
+
1597
+ #### Call Signature
1598
+
1599
+ > `static` **freeze**\<`T`\>(`o`): `Readonly`\<`T`\>
1600
+
1601
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:234
1602
+
1603
+ Prevents the modification of existing property attributes and values, and prevents the addition of new properties.
1604
+
1605
+ ##### Type Parameters
1606
+
1607
+ • **T**
1608
+
1609
+ ##### Parameters
1610
+
1611
+ ###### o
1612
+
1613
+ `T`
1614
+
1615
+ Object on which to lock the attributes.
1616
+
1617
+ ##### Returns
1618
+
1619
+ `Readonly`\<`T`\>
1620
+
1621
+ ***
1622
+
1623
+ ### fromEntries()
1624
+
1625
+ #### Call Signature
1626
+
1627
+ > `static` **fromEntries**\<`T`\>(`entries`): `object`
1628
+
1629
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2019.object.d.ts:26
1630
+
1631
+ Returns an object created by key-value entries for properties and methods
1632
+
1633
+ ##### Type Parameters
1634
+
1635
+ • **T** = `any`
1636
+
1637
+ ##### Parameters
1638
+
1639
+ ###### entries
1640
+
1641
+ `Iterable`\<readonly \[`PropertyKey`, `T`\]\>
1642
+
1643
+ An iterable object that contains key-value entries for properties and methods.
1644
+
1645
+ ##### Returns
1646
+
1647
+ `object`
1648
+
1649
+ #### Call Signature
1650
+
1651
+ > `static` **fromEntries**(`entries`): `any`
1652
+
1653
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2019.object.d.ts:32
1654
+
1655
+ Returns an object created by key-value entries for properties and methods
1656
+
1657
+ ##### Parameters
1658
+
1659
+ ###### entries
1660
+
1661
+ `Iterable`\<readonly `any`[]\>
1662
+
1663
+ An iterable object that contains key-value entries for properties and methods.
1664
+
1665
+ ##### Returns
1666
+
1667
+ `any`
1668
+
1669
+ ***
1670
+
1671
+ ### get()
1672
+
1673
+ > `static` **get**(`name`): [`ToolFunc`](ToolFunc.md)
1674
+
1675
+ Defined in: [packages/ai-tool/src/tool-func.ts:59](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L59)
1676
+
1677
+ #### Parameters
1678
+
1679
+ ##### name
1680
+
1681
+ `string`
1682
+
1683
+ #### Returns
1684
+
1685
+ [`ToolFunc`](ToolFunc.md)
1686
+
1687
+ ***
1688
+
1689
+ ### getAllByTag()
1690
+
1691
+ > `static` **getAllByTag**(`tagName`): [`ToolFunc`](ToolFunc.md)[]
1692
+
1693
+ Defined in: [packages/ai-tool/src/tool-func.ts:87](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L87)
1694
+
1695
+ #### Parameters
1696
+
1697
+ ##### tagName
1698
+
1699
+ `string`
1700
+
1701
+ #### Returns
1702
+
1703
+ [`ToolFunc`](ToolFunc.md)[]
1704
+
1705
+ ***
1706
+
1707
+ ### getByTag()
1708
+
1709
+ > `static` **getByTag**(`tagName`): `undefined` \| [`ToolFunc`](ToolFunc.md)
1710
+
1711
+ Defined in: [packages/ai-tool/src/tool-func.ts:67](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L67)
1712
+
1713
+ #### Parameters
1714
+
1715
+ ##### tagName
1716
+
1717
+ `string`
1718
+
1719
+ #### Returns
1720
+
1721
+ `undefined` \| [`ToolFunc`](ToolFunc.md)
1722
+
1723
+ ***
1724
+
1725
+ ### getFunc()
1726
+
1727
+ > `static` **getFunc**(`name`): `any`
1728
+
1729
+ Defined in: [packages/ai-tool/src/tool-func.ts:128](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L128)
1730
+
1731
+ #### Parameters
1732
+
1733
+ ##### name
1734
+
1735
+ `string`
1736
+
1737
+ #### Returns
1738
+
1739
+ `any`
1740
+
1741
+ ***
1742
+
1743
+ ### getFuncWithPos()
1744
+
1745
+ > `static` **getFuncWithPos**(`name`): `any`
1746
+
1747
+ Defined in: [packages/ai-tool/src/tool-func.ts:149](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L149)
1748
+
1749
+ #### Parameters
1750
+
1751
+ ##### name
1752
+
1753
+ `string`
1754
+
1755
+ #### Returns
1756
+
1757
+ `any`
1758
+
1759
+ ***
1760
+
1761
+ ### getOwnPropertyDescriptor()
1762
+
1763
+ > `static` **getOwnPropertyDescriptor**(`o`, `p`): `undefined` \| `PropertyDescriptor`
1764
+
1765
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:175
1766
+
1767
+ Gets the own property descriptor of the specified object.
1768
+ An own property descriptor is one that is defined directly on the object and is not inherited from the object's prototype.
1769
+
1770
+ #### Parameters
1771
+
1772
+ ##### o
1773
+
1774
+ `any`
1775
+
1776
+ Object that contains the property.
1777
+
1778
+ ##### p
1779
+
1780
+ `PropertyKey`
1781
+
1782
+ Name of the property.
1783
+
1784
+ #### Returns
1785
+
1786
+ `undefined` \| `PropertyDescriptor`
1787
+
1788
+ ***
1789
+
1790
+ ### getOwnPropertyDescriptors()
1791
+
1792
+ > `static` **getOwnPropertyDescriptors**\<`T`\>(`o`): \{ \[P in string \| number \| symbol\]: TypedPropertyDescriptor\<T\[P\]\> \} & `object`
1793
+
1794
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2017.object.d.ts:48
1795
+
1796
+ Returns an object containing all own property descriptors of an object
1797
+
1798
+ #### Type Parameters
1799
+
1800
+ • **T**
1801
+
1802
+ #### Parameters
1803
+
1804
+ ##### o
1805
+
1806
+ `T`
1807
+
1808
+ Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.
1809
+
1810
+ #### Returns
1811
+
1812
+ \{ \[P in string \| number \| symbol\]: TypedPropertyDescriptor\<T\[P\]\> \} & `object`
1813
+
1814
+ ***
1815
+
1816
+ ### getOwnPropertyNames()
1817
+
1818
+ > `static` **getOwnPropertyNames**(`o`): `string`[]
1819
+
1820
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:182
1821
+
1822
+ Returns the names of the own properties of an object. The own properties of an object are those that are defined directly
1823
+ on that object, and are not inherited from the object's prototype. The properties of an object include both fields (objects) and functions.
1824
+
1825
+ #### Parameters
1826
+
1827
+ ##### o
1828
+
1829
+ `any`
1830
+
1831
+ Object that contains the own properties.
1832
+
1833
+ #### Returns
1834
+
1835
+ `string`[]
1836
+
1837
+ ***
1838
+
1839
+ ### getOwnPropertySymbols()
1840
+
1841
+ > `static` **getOwnPropertySymbols**(`o`): `symbol`[]
1842
+
1843
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:319
1844
+
1845
+ Returns an array of all symbol properties found directly on object o.
1846
+
1847
+ #### Parameters
1848
+
1849
+ ##### o
1850
+
1851
+ `any`
1852
+
1853
+ Object to retrieve the symbols from.
1854
+
1855
+ #### Returns
1856
+
1857
+ `symbol`[]
1858
+
1859
+ ***
1860
+
1861
+ ### getProperties()
1862
+
1863
+ > `static` **getProperties**(): `PropDescriptors`
1864
+
1865
+ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/advance.d.ts:10
1866
+
1867
+ get all properties descriptor include inherited.
1868
+
1869
+ #### Returns
1870
+
1871
+ `PropDescriptors`
1872
+
1873
+ ***
1874
+
1875
+ ### getPrototypeOf()
1876
+
1877
+ > `static` **getPrototypeOf**(`o`): `any`
1878
+
1879
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:167
1880
+
1881
+ Returns the prototype of an object.
1882
+
1883
+ #### Parameters
1884
+
1885
+ ##### o
1886
+
1887
+ `any`
1888
+
1889
+ The object that references the prototype.
1890
+
1891
+ #### Returns
1892
+
1893
+ `any`
1894
+
1895
+ ***
1896
+
1897
+ ### hasAsyncFeature()
1898
+
1899
+ > `static` **hasAsyncFeature**(`feature`): `boolean`
1900
+
1901
+ Defined in: [packages/ai-tool/src/tool-func.ts:105](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L105)
1902
+
1903
+ #### Parameters
1904
+
1905
+ ##### feature
1906
+
1907
+ [`AsyncFeatureBits`](../enumerations/AsyncFeatureBits.md)
1908
+
1909
+ #### Returns
1910
+
1911
+ `boolean`
1912
+
1913
+ ***
1914
+
1915
+ ### hasOwn()
1916
+
1917
+ > `static` **hasOwn**(`o`, `v`): `boolean`
1918
+
1919
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2022.object.d.ts:25
1920
+
1921
+ Determines whether an object has a property with the specified name.
1922
+
1923
+ #### Parameters
1924
+
1925
+ ##### o
1926
+
1927
+ `object`
1928
+
1929
+ An object.
1930
+
1931
+ ##### v
1932
+
1933
+ `PropertyKey`
1934
+
1935
+ A property name.
1936
+
1937
+ #### Returns
1938
+
1939
+ `boolean`
1940
+
1941
+ ***
1942
+
1943
+ ### is()
1944
+
1945
+ > `static` **is**(`value1`, `value2`): `boolean`
1946
+
1947
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:332
1948
+
1949
+ Returns true if the values are the same value, false otherwise.
1950
+
1951
+ #### Parameters
1952
+
1953
+ ##### value1
1954
+
1955
+ `any`
1956
+
1957
+ The first value.
1958
+
1959
+ ##### value2
1960
+
1961
+ `any`
1962
+
1963
+ The second value.
1964
+
1965
+ #### Returns
1966
+
1967
+ `boolean`
1968
+
1969
+ ***
1970
+
1971
+ ### isExtensible()
1972
+
1973
+ > `static` **isExtensible**(`o`): `boolean`
1974
+
1975
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:258
1976
+
1977
+ Returns a value that indicates whether new properties can be added to an object.
1978
+
1979
+ #### Parameters
1980
+
1981
+ ##### o
1982
+
1983
+ `any`
1984
+
1985
+ Object to test.
1986
+
1987
+ #### Returns
1988
+
1989
+ `boolean`
1990
+
1991
+ ***
1992
+
1993
+ ### isFrozen()
1994
+
1995
+ > `static` **isFrozen**(`o`): `boolean`
1996
+
1997
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:252
1998
+
1999
+ Returns true if existing property attributes and values cannot be modified in an object, and new properties cannot be added to the object.
2000
+
2001
+ #### Parameters
2002
+
2003
+ ##### o
2004
+
2005
+ `any`
2006
+
2007
+ Object to test.
2008
+
2009
+ #### Returns
2010
+
2011
+ `boolean`
2012
+
2013
+ ***
2014
+
2015
+ ### isSealed()
2016
+
2017
+ > `static` **isSealed**(`o`): `boolean`
2018
+
2019
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:246
2020
+
2021
+ Returns true if existing property attributes cannot be modified in an object and new properties cannot be added to the object.
2022
+
2023
+ #### Parameters
2024
+
2025
+ ##### o
2026
+
2027
+ `any`
2028
+
2029
+ Object to test.
2030
+
2031
+ #### Returns
2032
+
2033
+ `boolean`
2034
+
2035
+ ***
2036
+
2037
+ ### keys()
2038
+
2039
+ #### Call Signature
2040
+
2041
+ > `static` **keys**(`o`): `string`[]
2042
+
2043
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:264
2044
+
2045
+ Returns the names of the enumerable string properties and methods of an object.
2046
+
2047
+ ##### Parameters
2048
+
2049
+ ###### o
2050
+
2051
+ `object`
2052
+
2053
+ Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.
2054
+
2055
+ ##### Returns
2056
+
2057
+ `string`[]
2058
+
2059
+ #### Call Signature
2060
+
2061
+ > `static` **keys**(`o`): `string`[]
2062
+
2063
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:325
2064
+
2065
+ Returns the names of the enumerable string properties and methods of an object.
2066
+
2067
+ ##### Parameters
2068
+
2069
+ ###### o
2070
+
2071
+ Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.
2072
+
2073
+ ##### Returns
2074
+
2075
+ `string`[]
2076
+
2077
+ ***
2078
+
2079
+ ### list()
2080
+
2081
+ > `static` **list**(): [`Funcs`](../interfaces/Funcs.md)
2082
+
2083
+ Defined in: [packages/ai-tool/src/tool-func.ts:63](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L63)
2084
+
2085
+ #### Returns
2086
+
2087
+ [`Funcs`](../interfaces/Funcs.md)
2088
+
2089
+ ***
2090
+
2091
+ ### loadFrom()
2092
+
2093
+ > `static` **loadFrom**(): `Promise`\<`void`\>
2094
+
2095
+ Defined in: [packages/ai-tool/src/client-tools.ts:29](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/client-tools.ts#L29)
2096
+
2097
+ #### Returns
2098
+
2099
+ `Promise`\<`void`\>
2100
+
2101
+ ***
2102
+
2103
+ ### loadFromSync()
2104
+
2105
+ > `static` **loadFromSync**(`items`): `void`
2106
+
2107
+ Defined in: [packages/ai-tool/src/client-tools.ts:41](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/client-tools.ts#L41)
2108
+
2109
+ #### Parameters
2110
+
2111
+ ##### items
2112
+
2113
+ [`Funcs`](../interfaces/Funcs.md)
2114
+
2115
+ #### Returns
2116
+
2117
+ `void`
2118
+
2119
+ ***
2120
+
2121
+ ### preventExtensions()
2122
+
2123
+ > `static` **preventExtensions**\<`T`\>(`o`): `T`
2124
+
2125
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:240
2126
+
2127
+ Prevents the addition of new properties to an object.
2128
+
2129
+ #### Type Parameters
2130
+
2131
+ • **T**
2132
+
2133
+ #### Parameters
2134
+
2135
+ ##### o
2136
+
2137
+ `T`
2138
+
2139
+ Object to make non-extensible.
2140
+
2141
+ #### Returns
2142
+
2143
+ `T`
2144
+
2145
+ ***
2146
+
2147
+ ### register()
2148
+
2149
+ #### Call Signature
2150
+
2151
+ > `static` **register**(`name`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
2152
+
2153
+ Defined in: [packages/ai-tool/src/tool-func.ts:154](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L154)
2154
+
2155
+ ##### Parameters
2156
+
2157
+ ###### name
2158
+
2159
+ `string`
2160
+
2161
+ ###### options
2162
+
2163
+ [`FuncItem`](../interfaces/FuncItem.md)
2164
+
2165
+ ##### Returns
2166
+
2167
+ `boolean` \| [`ToolFunc`](ToolFunc.md)
2168
+
2169
+ #### Call Signature
2170
+
2171
+ > `static` **register**(`func`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
2172
+
2173
+ Defined in: [packages/ai-tool/src/tool-func.ts:155](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L155)
2174
+
2175
+ ##### Parameters
2176
+
2177
+ ###### func
2178
+
2179
+ `Function`
2180
+
2181
+ ###### options
2182
+
2183
+ [`FuncItem`](../interfaces/FuncItem.md)
2184
+
2185
+ ##### Returns
2186
+
2187
+ `boolean` \| [`ToolFunc`](ToolFunc.md)
2188
+
2189
+ #### Call Signature
2190
+
2191
+ > `static` **register**(`name`, `options`?): `boolean` \| [`ToolFunc`](ToolFunc.md)
2192
+
2193
+ Defined in: [packages/ai-tool/src/tool-func.ts:156](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L156)
2194
+
2195
+ ##### Parameters
2196
+
2197
+ ###### name
2198
+
2199
+ `string` | `Function` | [`ToolFunc`](ToolFunc.md) | [`FuncItem`](../interfaces/FuncItem.md)
2200
+
2201
+ ###### options?
2202
+
2203
+ [`FuncItem`](../interfaces/FuncItem.md)
2204
+
2205
+ ##### Returns
2206
+
2207
+ `boolean` \| [`ToolFunc`](ToolFunc.md)
2208
+
2209
+ ***
2210
+
2211
+ ### run()
2212
+
2213
+ > `static` **run**(`name`, `params`?): `Promise`\<`any`\>
2214
+
2215
+ Defined in: [packages/ai-tool/src/tool-func.ts:112](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L112)
2216
+
2217
+ #### Parameters
2218
+
2219
+ ##### name
2220
+
2221
+ `string`
2222
+
2223
+ ##### params?
2224
+
2225
+ `any`
2226
+
2227
+ #### Returns
2228
+
2229
+ `Promise`\<`any`\>
2230
+
2231
+ ***
2232
+
2233
+ ### runSync()
2234
+
2235
+ > `static` **runSync**(`name`, `params`?): `any`
2236
+
2237
+ Defined in: [packages/ai-tool/src/tool-func.ts:120](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L120)
2238
+
2239
+ #### Parameters
2240
+
2241
+ ##### name
2242
+
2243
+ `string`
2244
+
2245
+ ##### params?
2246
+
2247
+ `any`
2248
+
2249
+ #### Returns
2250
+
2251
+ `any`
2252
+
2253
+ ***
2254
+
2255
+ ### runWithPos()
2256
+
2257
+ > `static` **runWithPos**(`name`, ...`params`): `Promise`\<`any`\>
2258
+
2259
+ Defined in: [packages/ai-tool/src/tool-func.ts:133](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L133)
2260
+
2261
+ #### Parameters
2262
+
2263
+ ##### name
2264
+
2265
+ `string`
2266
+
2267
+ ##### params
2268
+
2269
+ ...`any`[]
2270
+
2271
+ #### Returns
2272
+
2273
+ `Promise`\<`any`\>
2274
+
2275
+ ***
2276
+
2277
+ ### runWithPosSync()
2278
+
2279
+ > `static` **runWithPosSync**(`name`, ...`params`): `any`
2280
+
2281
+ Defined in: [packages/ai-tool/src/tool-func.ts:141](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L141)
2282
+
2283
+ #### Parameters
2284
+
2285
+ ##### name
2286
+
2287
+ `string`
2288
+
2289
+ ##### params
2290
+
2291
+ ...`any`[]
2292
+
2293
+ #### Returns
2294
+
2295
+ `any`
2296
+
2297
+ ***
2298
+
2299
+ ### seal()
2300
+
2301
+ > `static` **seal**\<`T`\>(`o`): `T`
2302
+
2303
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:216
2304
+
2305
+ Prevents the modification of attributes of existing properties, and prevents the addition of new properties.
2306
+
2307
+ #### Type Parameters
2308
+
2309
+ • **T**
2310
+
2311
+ #### Parameters
2312
+
2313
+ ##### o
2314
+
2315
+ `T`
2316
+
2317
+ Object on which to lock the attributes.
2318
+
2319
+ #### Returns
2320
+
2321
+ `T`
2322
+
2323
+ ***
2324
+
2325
+ ### setApiRoot()
2326
+
2327
+ > `static` **setApiRoot**(`v`): `void`
2328
+
2329
+ Defined in: [packages/ai-tool/src/client-tools.ts:23](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/client-tools.ts#L23)
2330
+
2331
+ #### Parameters
2332
+
2333
+ ##### v
2334
+
2335
+ `string`
2336
+
2337
+ #### Returns
2338
+
2339
+ `void`
2340
+
2341
+ ***
2342
+
2343
+ ### setPrototypeOf()
2344
+
2345
+ > `static` **setPrototypeOf**(`o`, `proto`): `any`
2346
+
2347
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:339
2348
+
2349
+ Sets the prototype of a specified object o to object proto or null. Returns the object o.
2350
+
2351
+ #### Parameters
2352
+
2353
+ ##### o
2354
+
2355
+ `any`
2356
+
2357
+ The object to change its prototype.
2358
+
2359
+ ##### proto
2360
+
2361
+ The value of the new prototype or null.
2362
+
2363
+ `null` | `object`
2364
+
2365
+ #### Returns
2366
+
2367
+ `any`
2368
+
2369
+ ***
2370
+
2371
+ ### unregister()
2372
+
2373
+ > `static` **unregister**(`name`): `undefined` \| [`ToolFunc`](ToolFunc.md)
2374
+
2375
+ Defined in: [packages/ai-tool/src/tool-func.ts:184](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L184)
2376
+
2377
+ #### Parameters
2378
+
2379
+ ##### name
2380
+
2381
+ `string`
2382
+
2383
+ #### Returns
2384
+
2385
+ `undefined` \| [`ToolFunc`](ToolFunc.md)
2386
+
2387
+ ***
2388
+
2389
+ ### values()
2390
+
2391
+ #### Call Signature
2392
+
2393
+ > `static` **values**\<`T`\>(`o`): `T`[]
2394
+
2395
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2017.object.d.ts:24
2396
+
2397
+ Returns an array of values of the enumerable own properties of an object
2398
+
2399
+ ##### Type Parameters
2400
+
2401
+ • **T**
2402
+
2403
+ ##### Parameters
2404
+
2405
+ ###### o
2406
+
2407
+ Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.
2408
+
2409
+ \{\} | `ArrayLike`\<`T`\>
2410
+
2411
+ ##### Returns
2412
+
2413
+ `T`[]
2414
+
2415
+ #### Call Signature
2416
+
2417
+ > `static` **values**(`o`): `any`[]
2418
+
2419
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2017.object.d.ts:30
2420
+
2421
+ Returns an array of values of the enumerable own properties of an object
2422
+
2423
+ ##### Parameters
2424
+
2425
+ ###### o
2426
+
2427
+ Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.
2428
+
2429
+ ##### Returns
2430
+
2431
+ `any`[]