@isdk/ai-tool 0.5.1 → 0.5.2

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