@isdk/ai-tool 0.5.2 → 0.5.3

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