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