@isdk/ai-tool 0.3.0 → 0.5.0

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