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