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