@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,3119 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / EventClient
6
-
7
- # Class: EventClient
8
-
9
- ## Extends
10
-
11
- - [`ResClientTools`](ResClientTools.md)
12
-
13
- ## Constructors
14
-
15
- ### new EventClient()
16
-
17
- > **new EventClient**(`name`, `options`): [`EventClient`](EventClient.md)
18
-
19
- The initial value of Object.prototype.constructor is the standard built-in Object constructor.
20
-
21
- #### Parameters
22
-
23
- • **name**: `string` \| `Function` \| [`FuncItem`](../interfaces/FuncItem.md)
24
-
25
- • **options**: `any` = `{}`
26
-
27
- #### Returns
28
-
29
- [`EventClient`](EventClient.md)
30
-
31
- #### Inherited from
32
-
33
- [`ResClientTools`](ResClientTools.md).[`constructor`](ResClientTools.md#constructors)
34
-
35
- #### Defined in
36
-
37
- [packages/ai-tool/src/tool-func.ts:210](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L210)
38
-
39
- ## Properties
40
-
41
- ### \_es
42
-
43
- > **\_es**: `undefined` \| `EventSource`
44
-
45
- #### Defined in
46
-
47
- [packages/ai-tool/src/funcs/event-client.ts:13](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/funcs/event-client.ts#L13)
48
-
49
- ***
50
-
51
- ### \_esEvents
52
-
53
- > **\_esEvents**: `undefined` \| `string`[]
54
-
55
- #### Defined in
56
-
57
- [packages/ai-tool/src/funcs/event-client.ts:15](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/funcs/event-client.ts#L15)
58
-
59
- ***
60
-
61
- ### \_forwardEvents
62
-
63
- > **\_forwardEvents**: `Set`\<`string`\>
64
-
65
- #### Defined in
66
-
67
- [packages/ai-tool/src/funcs/event-client.ts:18](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/funcs/event-client.ts#L18)
68
-
69
- ***
70
-
71
- ### \_sseEvents
72
-
73
- > **\_sseEvents**: `Record`\<`string`, (`e`) => `void`\> = `{}`
74
-
75
- #### Defined in
76
-
77
- [packages/ai-tool/src/funcs/event-client.ts:17](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/funcs/event-client.ts#L17)
78
-
79
- ***
80
-
81
- ### $attributes
82
-
83
- > **$attributes**: `Properties`
84
-
85
- #### Inherited from
86
-
87
- [`ResClientTools`](ResClientTools.md).[`$attributes`](ResClientTools.md#$attributes)
88
-
89
- #### Defined in
90
-
91
- node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/advance.d.ts:5
92
-
93
- ***
94
-
95
- ### action?
96
-
97
- > `optional` **action**: `"get"` \| `"post"` \| `"put"` \| `"delete"` \| `"patch"` \| `"list"` \| `"res"`
98
-
99
- #### Inherited from
100
-
101
- [`ResClientTools`](ResClientTools.md).[`action`](ResClientTools.md#action)
102
-
103
- #### Defined in
104
-
105
- [packages/ai-tool/src/utils/consts.ts:35](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/consts.ts#L35)
106
-
107
- ***
108
-
109
- ### apiRoot
110
-
111
- > **apiRoot**: `undefined` \| `string`
112
-
113
- #### Inherited from
114
-
115
- [`ResClientTools`](ResClientTools.md).[`apiRoot`](ResClientTools.md#apiroot)
116
-
117
- #### Defined in
118
-
119
- [packages/ai-tool/src/client-tools.ts:16](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/client-tools.ts#L16)
120
-
121
- ***
122
-
123
- ### constructor
124
-
125
- > **constructor**: `Function`
126
-
127
- The initial value of Object.prototype.constructor is the standard built-in Object constructor.
128
-
129
- #### Inherited from
130
-
131
- `ResClientTools.constructor`
132
-
133
- #### Defined in
134
-
135
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:125
136
-
137
- ***
138
-
139
- ### defaultOptions
140
-
141
- > **defaultOptions**: `object`
142
-
143
- The default options for export and assign
144
-
145
- #### assign?
146
-
147
- > `optional` **assign**: `IMergeOptions`
148
-
149
- #### export?
150
-
151
- > `optional` **export**: `IMergeOptions`
152
-
153
- #### Inherited from
154
-
155
- [`ResClientTools`](ResClientTools.md).[`defaultOptions`](ResClientTools.md#defaultoptions)
156
-
157
- #### Defined in
158
-
159
- node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:74
160
-
161
- ***
162
-
163
- ### description
164
-
165
- > **description**: `string` = `'subscribe server sent event'`
166
-
167
- #### Defined in
168
-
169
- [packages/ai-tool/src/funcs/event-client.ts:45](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/funcs/event-client.ts#L45)
170
-
171
- ***
172
-
173
- ### ebListener()
174
-
175
- > **ebListener**: (`this`, ...`data`) => `Promise`\<`void`\>
176
-
177
- #### Parameters
178
-
179
- • **this**: `Event`
180
-
181
- • ...**data**: `any`[]
182
-
183
- #### Returns
184
-
185
- `Promise`\<`void`\>
186
-
187
- #### Defined in
188
-
189
- [packages/ai-tool/src/funcs/event-client.ts:86](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/funcs/event-client.ts#L86)
190
-
191
- ***
192
-
193
- ### fetchOptions?
194
-
195
- > `optional` **fetchOptions**: `any`
196
-
197
- #### Inherited from
198
-
199
- [`ResClientTools`](ResClientTools.md).[`fetchOptions`](ResClientTools.md#fetchoptions)
200
-
201
- #### Defined in
202
-
203
- [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/consts.ts#L36)
204
-
205
- ***
206
-
207
- ### isApi?
208
-
209
- > `optional` **isApi**: `boolean`
210
-
211
- #### Inherited from
212
-
213
- [`ResClientTools`](ResClientTools.md).[`isApi`](ResClientTools.md#isapi)
214
-
215
- #### Defined in
216
-
217
- [packages/ai-tool/src/tool-func.ts:47](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L47)
218
-
219
- ***
220
-
221
- ### name
222
-
223
- > **name**: `string` = `EventName`
224
-
225
- #### Overrides
226
-
227
- [`ResClientTools`](ResClientTools.md).[`name`](ResClientTools.md#name)
228
-
229
- #### Defined in
230
-
231
- [packages/ai-tool/src/funcs/event-client.ts:44](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/funcs/event-client.ts#L44)
232
-
233
- ***
234
-
235
- ### nonExported1stChar
236
-
237
- > **nonExported1stChar**: `string`
238
-
239
- the property with the default prefix '$' will not be exported.
240
-
241
- #### Inherited from
242
-
243
- [`ResClientTools`](ResClientTools.md).[`nonExported1stChar`](ResClientTools.md#nonexported1stchar)
244
-
245
- #### Defined in
246
-
247
- node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:78
248
-
249
- ***
250
-
251
- ### params?
252
-
253
- > `optional` **params**: [`FuncParams`](../interfaces/FuncParams.md) \| [`FuncParam`](../interfaces/FuncParam.md)[]
254
-
255
- #### Inherited from
256
-
257
- [`ResClientTools`](ResClientTools.md).[`params`](ResClientTools.md#params)
258
-
259
- #### Defined in
260
-
261
- [packages/ai-tool/src/tool-func.ts:42](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L42)
262
-
263
- ***
264
-
265
- ### result?
266
-
267
- > `optional` **result**: `string`
268
-
269
- #### Inherited from
270
-
271
- [`ResClientTools`](ResClientTools.md).[`result`](ResClientTools.md#result)
272
-
273
- #### Defined in
274
-
275
- [packages/ai-tool/src/tool-func.ts:43](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L43)
276
-
277
- ***
278
-
279
- ### scope?
280
-
281
- > `optional` **scope**: `any`
282
-
283
- #### Inherited from
284
-
285
- [`ResClientTools`](ResClientTools.md).[`scope`](ResClientTools.md#scope)
286
-
287
- #### Defined in
288
-
289
- [packages/ai-tool/src/tool-func.ts:44](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L44)
290
-
291
- ***
292
-
293
- ### setup()?
294
-
295
- > `optional` **setup**: (`this`, `options`?) => `void`
296
-
297
- #### Parameters
298
-
299
- • **this**: [`ToolFunc`](ToolFunc.md)
300
-
301
- • **options?**: [`FuncItem`](../interfaces/FuncItem.md)
302
-
303
- #### Returns
304
-
305
- `void`
306
-
307
- #### Inherited from
308
-
309
- [`ResClientTools`](ResClientTools.md).[`setup`](ResClientTools.md#setup)
310
-
311
- #### Defined in
312
-
313
- [packages/ai-tool/src/tool-func.ts:46](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L46)
314
-
315
- ***
316
-
317
- ### should
318
-
319
- > **should**: `Assertion`
320
-
321
- #### Inherited from
322
-
323
- [`ResClientTools`](ResClientTools.md).[`should`](ResClientTools.md#should)
324
-
325
- #### Defined in
326
-
327
- node\_modules/.pnpm/@types+chai@4.3.20/node\_modules/@types/chai/index.d.ts:2100
328
-
329
- ***
330
-
331
- ### stream?
332
-
333
- > `optional` **stream**: `boolean`
334
-
335
- #### Inherited from
336
-
337
- [`ResClientTools`](ResClientTools.md).[`stream`](ResClientTools.md#stream)
338
-
339
- #### Defined in
340
-
341
- [packages/ai-tool/src/tool-func.ts:48](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L48)
342
-
343
- ***
344
-
345
- ### tags?
346
-
347
- > `optional` **tags**: `string` \| `string`[]
348
-
349
- #### Inherited from
350
-
351
- [`ResClientTools`](ResClientTools.md).[`tags`](ResClientTools.md#tags)
352
-
353
- #### Defined in
354
-
355
- [packages/ai-tool/src/tool-func.ts:45](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L45)
356
-
357
- ***
358
-
359
- ### dataPath
360
-
361
- > `static` **dataPath**: `string`
362
-
363
- #### Inherited from
364
-
365
- [`ResClientTools`](ResClientTools.md).[`dataPath`](ResClientTools.md#datapath)
366
-
367
- #### Defined in
368
-
369
- [packages/ai-tool/src/tool-func.ts:75](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L75)
370
-
371
- ***
372
-
373
- ### items
374
-
375
- > `static` **items**: [`Funcs`](../interfaces/Funcs.md) = `{}`
376
-
377
- #### Inherited from
378
-
379
- [`ResClientTools`](ResClientTools.md).[`items`](ResClientTools.md#items)
380
-
381
- #### Defined in
382
-
383
- [packages/ai-tool/src/tool-func.ts:74](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L74)
384
-
385
- ## Accessors
386
-
387
- ### active
388
-
389
- > `get` **active**(): `boolean`
390
-
391
- > `set` **active**(`v`): `void`
392
-
393
- #### Parameters
394
-
395
- • **v**: `boolean`
396
-
397
- #### Returns
398
-
399
- `boolean`
400
-
401
- #### Defined in
402
-
403
- [packages/ai-tool/src/funcs/event-client.ts:29](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/funcs/event-client.ts#L29)
404
-
405
- ***
406
-
407
- ### evtSource
408
-
409
- > `get` **evtSource**(): `EventSource`
410
-
411
- #### Returns
412
-
413
- `EventSource`
414
-
415
- #### Defined in
416
-
417
- [packages/ai-tool/src/funcs/event-client.ts:20](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/funcs/event-client.ts#L20)
418
-
419
- ***
420
-
421
- ### apiRoot
422
-
423
- > `get` `static` **apiRoot**(): `undefined` \| `string`
424
-
425
- #### Returns
426
-
427
- `undefined` \| `string`
428
-
429
- #### Inherited from
430
-
431
- [`ResClientTools`](ResClientTools.md).[`apiRoot`](ResClientTools.md#apiroot-1)
432
-
433
- #### Defined in
434
-
435
- [packages/ai-tool/src/client-tools.ts:19](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/client-tools.ts#L19)
436
-
437
- ## Methods
438
-
439
- ### \_func()
440
-
441
- > **\_func**(`action`, `options`): `Promise`\<`any`\>
442
-
443
- #### Parameters
444
-
445
- • **action**: `"get"` \| `"post"` \| `"put"` \| `"delete"` \| `"patch"` \| `"list"` \| `"res"`
446
-
447
- • **options**: `RpcMethodsClientFuncParams`
448
-
449
- #### Returns
450
-
451
- `Promise`\<`any`\>
452
-
453
- #### Inherited from
454
-
455
- [`ResClientTools`](ResClientTools.md).[`_func`](ResClientTools.md#_func)
456
-
457
- #### Defined in
458
-
459
- [packages/ai-tool/src/rpc-methods-client-tool.ts:10](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/rpc-methods-client-tool.ts#L10)
460
-
461
- ***
462
-
463
- ### arr2ObjParams()
464
-
465
- > **arr2ObjParams**(`params`): `any`[]
466
-
467
- #### Parameters
468
-
469
- • **params**: `any`[]
470
-
471
- #### Returns
472
-
473
- `any`[]
474
-
475
- #### Inherited from
476
-
477
- [`ResClientTools`](ResClientTools.md).[`arr2ObjParams`](ResClientTools.md#arr2objparams)
478
-
479
- #### Defined in
480
-
481
- [packages/ai-tool/src/tool-func.ts:254](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L254)
482
-
483
- ***
484
-
485
- ### assign()
486
-
487
- > **assign**(`src`, `options`?): `this`
488
-
489
- Assign the values from the src object.
490
-
491
- #### Parameters
492
-
493
- • **src**: `any`
494
-
495
- the source object
496
-
497
- • **options?**: `IMergeOptions`
498
-
499
- #### Returns
500
-
501
- `this`
502
-
503
- this object
504
-
505
- #### Inherited from
506
-
507
- [`ResClientTools`](ResClientTools.md).[`assign`](ResClientTools.md#assign-1)
508
-
509
- #### Defined in
510
-
511
- node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:106
512
-
513
- ***
514
-
515
- ### assignMethods()
516
-
517
- > **assignMethods**(`methods`): `void`
518
-
519
- #### Parameters
520
-
521
- • **methods**: `string`[]
522
-
523
- #### Returns
524
-
525
- `void`
526
-
527
- #### Inherited from
528
-
529
- [`ResClientTools`](ResClientTools.md).[`assignMethods`](ResClientTools.md#assignmethods)
530
-
531
- #### Defined in
532
-
533
- [packages/ai-tool/src/rpc-methods-client-tool.ts:27](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/rpc-methods-client-tool.ts#L27)
534
-
535
- ***
536
-
537
- ### assignProperty()
538
-
539
- > **assignProperty**(`src`, `name`, `value`, `attrs`?, `options`?): `void`
540
-
541
- Assign a property of src to this object.
542
-
543
- #### Parameters
544
-
545
- • **src**: `any`
546
-
547
- the src object
548
-
549
- • **name**: `string`
550
-
551
- the property name to assign
552
-
553
- • **value**: `any`
554
-
555
- the property value to assign
556
-
557
- • **attrs?**: `any`
558
-
559
- the attributes object
560
-
561
- • **options?**: `IMergeOptions`
562
-
563
- #### Returns
564
-
565
- `void`
566
-
567
- #### Inherited from
568
-
569
- [`ResClientTools`](ResClientTools.md).[`assignProperty`](ResClientTools.md#assignproperty)
570
-
571
- #### Defined in
572
-
573
- node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:117
574
-
575
- ***
576
-
577
- ### assignPropertyTo()
578
-
579
- > `abstract` **assignPropertyTo**(`dest`, `src`, `name`, `value`, `attrs`?, `options`?): `void`
580
-
581
- Assign the property value from the src to destination object.
582
-
583
- #### Parameters
584
-
585
- • **dest**: `any`
586
-
587
- The destination object
588
-
589
- • **src**: `any`
590
-
591
- The src object
592
-
593
- • **name**: `string`
594
-
595
- The property name
596
-
597
- • **value**: `any`
598
-
599
- The property value
600
-
601
- • **attrs?**: `any`
602
-
603
- The attributes object of the property
604
-
605
- • **options?**: `IMergeOptions`
606
-
607
- #### Returns
608
-
609
- `void`
610
-
611
- #### Inherited from
612
-
613
- [`ResClientTools`](ResClientTools.md).[`assignPropertyTo`](ResClientTools.md#assignpropertyto)
614
-
615
- #### Defined in
616
-
617
- node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:131
618
-
619
- ***
620
-
621
- ### assignTo()
622
-
623
- > **assignTo**(`dest`?, `options`?): `any`
624
-
625
- Assign this attributes to the dest object
626
-
627
- #### Parameters
628
-
629
- • **dest?**: `any`
630
-
631
- the destination object
632
-
633
- • **options?**: `IMergeOptions`
634
-
635
- #### Returns
636
-
637
- `any`
638
-
639
- the dest object
640
-
641
- #### Inherited from
642
-
643
- [`ResClientTools`](ResClientTools.md).[`assignTo`](ResClientTools.md#assignto)
644
-
645
- #### Defined in
646
-
647
- node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:191
648
-
649
- ***
650
-
651
- ### clone()
652
-
653
- > **clone**(`options`?): `any`
654
-
655
- Create a new object with the same values of attributes.
656
-
657
- #### Parameters
658
-
659
- • **options?**: `IMergeOptions`
660
-
661
- #### Returns
662
-
663
- `any`
664
-
665
- the new object
666
-
667
- #### Inherited from
668
-
669
- [`ResClientTools`](ResClientTools.md).[`clone`](ResClientTools.md#clone)
670
-
671
- #### Defined in
672
-
673
- node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:155
674
-
675
- ***
676
-
677
- ### cloneTo()
678
-
679
- > **cloneTo**(`dest`, `options`?): `any`
680
-
681
- Create and assign the values to the destination object.
682
-
683
- #### Parameters
684
-
685
- • **dest**: `any`
686
-
687
- the destination object
688
-
689
- • **options?**: `IMergeOptions`
690
-
691
- #### Returns
692
-
693
- `any`
694
-
695
- the new dest object
696
-
697
- #### Inherited from
698
-
699
- [`ResClientTools`](ResClientTools.md).[`cloneTo`](ResClientTools.md#cloneto)
700
-
701
- #### Defined in
702
-
703
- node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:148
704
-
705
- ***
706
-
707
- ### defineProperties()
708
-
709
- > `abstract` **defineProperties**(`aProperties`): `any`
710
-
711
- Define the attributes of this object.
712
-
713
- #### Parameters
714
-
715
- • **aProperties**: `SimplePropDescriptors`
716
-
717
- the defined attributes of the object
718
-
719
- #### Returns
720
-
721
- `any`
722
-
723
- #### Inherited from
724
-
725
- [`ResClientTools`](ResClientTools.md).[`defineProperties`](ResClientTools.md#defineproperties)
726
-
727
- #### Defined in
728
-
729
- node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:89
730
-
731
- ***
732
-
733
- ### delete()?
734
-
735
- > `optional` **delete**(`__namedParameters`): `any`
736
-
737
- #### Parameters
738
-
739
- • **\_\_namedParameters**: [`ResClientFuncParams`](../interfaces/ResClientFuncParams.md)
740
-
741
- #### Returns
742
-
743
- `any`
744
-
745
- #### Inherited from
746
-
747
- [`ResClientTools`](ResClientTools.md).[`delete`](ResClientTools.md#delete)
748
-
749
- #### Defined in
750
-
751
- [packages/ai-tool/src/res-client-tools.ts:13](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/res-client-tools.ts#L13)
752
-
753
- ***
754
-
755
- ### errorFrom()
756
-
757
- > **errorFrom**(`res`): `Promise`\<[`CommonError`](CommonError.md)\>
758
-
759
- #### Parameters
760
-
761
- • **res**: `Response`
762
-
763
- #### Returns
764
-
765
- `Promise`\<[`CommonError`](CommonError.md)\>
766
-
767
- #### Inherited from
768
-
769
- [`ResClientTools`](ResClientTools.md).[`errorFrom`](ResClientTools.md#errorfrom)
770
-
771
- #### Defined in
772
-
773
- [packages/ai-tool/src/client-tools.ts:112](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/client-tools.ts#L112)
774
-
775
- ***
776
-
777
- ### esListener()
778
-
779
- > **esListener**(`event`): `void`
780
-
781
- #### Parameters
782
-
783
- • **event**: `MessageEvent`\<`any`\>
784
-
785
- #### Returns
786
-
787
- `void`
788
-
789
- #### Defined in
790
-
791
- [packages/ai-tool/src/funcs/event-client.ts:69](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/funcs/event-client.ts#L69)
792
-
793
- ***
794
-
795
- ### exportTo()
796
-
797
- > **exportTo**(`dest`, `options`?): `any`
798
-
799
- Export attributes to the dest json object.
800
-
801
- #### Parameters
802
-
803
- • **dest**: `any`
804
-
805
- the destination object
806
-
807
- • **options?**: `IExportOptions`
808
-
809
- #### Returns
810
-
811
- `any`
812
-
813
- the dest object.
814
-
815
- #### Inherited from
816
-
817
- [`ResClientTools`](ResClientTools.md).[`exportTo`](ResClientTools.md#exportto)
818
-
819
- #### Defined in
820
-
821
- node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:173
822
-
823
- ***
824
-
825
- ### fetch()
826
-
827
- > **fetch**(`options`, `action`): `Promise`\<`Response`\>
828
-
829
- #### Parameters
830
-
831
- • **options**: [`ResClientFuncParams`](../interfaces/ResClientFuncParams.md)
832
-
833
- • **action**: `"get"` \| `"post"` \| `"put"` \| `"delete"` \| `"patch"` \| `"list"` \| `"res"`
834
-
835
- #### Returns
836
-
837
- `Promise`\<`Response`\>
838
-
839
- #### Inherited from
840
-
841
- [`ResClientTools`](ResClientTools.md).[`fetch`](ResClientTools.md#fetch)
842
-
843
- #### Defined in
844
-
845
- [packages/ai-tool/src/res-client-tools.ts:18](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/res-client-tools.ts#L18)
846
-
847
- ***
848
-
849
- ### forwardEvent()
850
-
851
- > **forwardEvent**(`events`): `void`
852
-
853
- forward local event(s) to server
854
-
855
- subscribe these local events to forward/publish to server
856
-
857
- Note: pls backendEventable(ClientTools or EventClient) first
858
-
859
- #### Parameters
860
-
861
- • **events**: `string` \| `string`[]
862
-
863
- #### Returns
864
-
865
- `void`
866
-
867
- #### Defined in
868
-
869
- [packages/ai-tool/src/funcs/event-client.ts:140](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/funcs/event-client.ts#L140)
870
-
871
- ***
872
-
873
- ### func()
874
-
875
- > **func**(`options`): `Promise`\<`any`\>
876
-
877
- #### Parameters
878
-
879
- • **options**: `RpcMethodsClientFuncParams`
880
-
881
- #### Returns
882
-
883
- `Promise`\<`any`\>
884
-
885
- #### Inherited from
886
-
887
- [`ResClientTools`](ResClientTools.md).[`func`](ResClientTools.md#func)
888
-
889
- #### Defined in
890
-
891
- [packages/ai-tool/src/rpc-methods-client-tool.ts:19](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/rpc-methods-client-tool.ts#L19)
892
-
893
- ***
894
-
895
- ### get()?
896
-
897
- > `optional` **get**(`__namedParameters`): `any`
898
-
899
- #### Parameters
900
-
901
- • **\_\_namedParameters**: [`ResClientFuncParams`](../interfaces/ResClientFuncParams.md)
902
-
903
- #### Returns
904
-
905
- `any`
906
-
907
- #### Inherited from
908
-
909
- [`ResClientTools`](ResClientTools.md).[`get`](ResClientTools.md#get)
910
-
911
- #### Defined in
912
-
913
- [packages/ai-tool/src/res-client-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/res-client-tools.ts#L10)
914
-
915
- ***
916
-
917
- ### getFunc()
918
-
919
- > **getFunc**(`name`?): `any`
920
-
921
- #### Parameters
922
-
923
- • **name?**: `string`
924
-
925
- #### Returns
926
-
927
- `any`
928
-
929
- #### Inherited from
930
-
931
- [`ResClientTools`](ResClientTools.md).[`getFunc`](ResClientTools.md#getfunc)
932
-
933
- #### Defined in
934
-
935
- [packages/ai-tool/src/tool-func.ts:307](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L307)
936
-
937
- ***
938
-
939
- ### getFuncWithPos()
940
-
941
- > **getFuncWithPos**(`name`?): `any`
942
-
943
- #### Parameters
944
-
945
- • **name?**: `string`
946
-
947
- #### Returns
948
-
949
- `any`
950
-
951
- #### Inherited from
952
-
953
- [`ResClientTools`](ResClientTools.md).[`getFuncWithPos`](ResClientTools.md#getfuncwithpos)
954
-
955
- #### Defined in
956
-
957
- [packages/ai-tool/src/tool-func.ts:331](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L331)
958
-
959
- ***
960
-
961
- ### getProperties()
962
-
963
- > `abstract` **getProperties**(): `PropDescriptors`
964
-
965
- Get the defined attributes.
966
-
967
- #### Returns
968
-
969
- `PropDescriptors`
970
-
971
- the descriptors of properties object
972
-
973
- #### Inherited from
974
-
975
- [`ResClientTools`](ResClientTools.md).[`getProperties`](ResClientTools.md#getproperties)
976
-
977
- #### Defined in
978
-
979
- node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:98
980
-
981
- ***
982
-
983
- ### getUrlParams()
984
-
985
- > **getUrlParams**(`objParam`): `string`
986
-
987
- #### Parameters
988
-
989
- • **objParam**: `any`
990
-
991
- #### Returns
992
-
993
- `string`
994
-
995
- #### Inherited from
996
-
997
- [`ResClientTools`](ResClientTools.md).[`getUrlParams`](ResClientTools.md#geturlparams)
998
-
999
- #### Defined in
1000
-
1001
- [packages/ai-tool/src/client-tools.ts:63](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/client-tools.ts#L63)
1002
-
1003
- ***
1004
-
1005
- ### hasAsyncFeature()
1006
-
1007
- > **hasAsyncFeature**(`feature`): `boolean`
1008
-
1009
- #### Parameters
1010
-
1011
- • **feature**: [`AsyncFeatureBits`](../enumerations/AsyncFeatureBits.md)
1012
-
1013
- #### Returns
1014
-
1015
- `boolean`
1016
-
1017
- #### Inherited from
1018
-
1019
- [`ResClientTools`](ResClientTools.md).[`hasAsyncFeature`](ResClientTools.md#hasasyncfeature)
1020
-
1021
- #### Defined in
1022
-
1023
- [packages/ai-tool/src/tool-func.ts:336](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L336)
1024
-
1025
- ***
1026
-
1027
- ### hasOwnProperty()
1028
-
1029
- > **hasOwnProperty**(`v`): `boolean`
1030
-
1031
- Determines whether an object has a property with the specified name.
1032
-
1033
- #### Parameters
1034
-
1035
- • **v**: `PropertyKey`
1036
-
1037
- A property name.
1038
-
1039
- #### Returns
1040
-
1041
- `boolean`
1042
-
1043
- #### Inherited from
1044
-
1045
- [`ResClientTools`](ResClientTools.md).[`hasOwnProperty`](ResClientTools.md#hasownproperty)
1046
-
1047
- #### Defined in
1048
-
1049
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:140
1050
-
1051
- ***
1052
-
1053
- ### init()
1054
-
1055
- > **init**(`events`): `Promise`\<`any`\>
1056
-
1057
- #### Parameters
1058
-
1059
- • **events**: `string` \| `string`[]
1060
-
1061
- #### Returns
1062
-
1063
- `Promise`\<`any`\>
1064
-
1065
- #### Defined in
1066
-
1067
- [packages/ai-tool/src/funcs/event-client.ts:172](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/funcs/event-client.ts#L172)
1068
-
1069
- ***
1070
-
1071
- ### initEventSource()
1072
-
1073
- > **initEventSource**(`events`?): `EventSource`
1074
-
1075
- #### Parameters
1076
-
1077
- • **events?**: `string` \| `string`[]
1078
-
1079
- #### Returns
1080
-
1081
- `EventSource`
1082
-
1083
- #### Defined in
1084
-
1085
- [packages/ai-tool/src/funcs/event-client.ts:47](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/funcs/event-client.ts#L47)
1086
-
1087
- ***
1088
-
1089
- ### initialize()
1090
-
1091
- > **initialize**(`src`?): `this`
1092
-
1093
- Initialize object and assign attribute values from src if src exists.
1094
-
1095
- #### Parameters
1096
-
1097
- • **src?**: `any`
1098
-
1099
- #### Returns
1100
-
1101
- `this`
1102
-
1103
- this object.
1104
-
1105
- #### Inherited from
1106
-
1107
- [`ResClientTools`](ResClientTools.md).[`initialize`](ResClientTools.md#initialize)
1108
-
1109
- #### Defined in
1110
-
1111
- node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:139
1112
-
1113
- ***
1114
-
1115
- ### isPrototypeOf()
1116
-
1117
- > **isPrototypeOf**(`v`): `boolean`
1118
-
1119
- Determines whether an object exists in another object's prototype chain.
1120
-
1121
- #### Parameters
1122
-
1123
- • **v**: `Object`
1124
-
1125
- Another object whose prototype chain is to be checked.
1126
-
1127
- #### Returns
1128
-
1129
- `boolean`
1130
-
1131
- #### Inherited from
1132
-
1133
- [`ResClientTools`](ResClientTools.md).[`isPrototypeOf`](ResClientTools.md#isprototypeof)
1134
-
1135
- #### Defined in
1136
-
1137
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:146
1138
-
1139
- ***
1140
-
1141
- ### isSame()
1142
-
1143
- > **isSame**(`src`, `options`?): `boolean`
1144
-
1145
- Check the src object whether “equals” this object.
1146
-
1147
- #### Parameters
1148
-
1149
- • **src**: `any`
1150
-
1151
- The source object
1152
-
1153
- • **options?**: `IMergeOptions`
1154
-
1155
- #### Returns
1156
-
1157
- `boolean`
1158
-
1159
- #### Inherited from
1160
-
1161
- [`ResClientTools`](ResClientTools.md).[`isSame`](ResClientTools.md#issame)
1162
-
1163
- #### Defined in
1164
-
1165
- node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:200
1166
-
1167
- ***
1168
-
1169
- ### isStream()
1170
-
1171
- > **isStream**(`params`): `undefined` \| `boolean`
1172
-
1173
- #### Parameters
1174
-
1175
- • **params**: `any`
1176
-
1177
- #### Returns
1178
-
1179
- `undefined` \| `boolean`
1180
-
1181
- #### Inherited from
1182
-
1183
- [`ResClientTools`](ResClientTools.md).[`isStream`](ResClientTools.md#isstream)
1184
-
1185
- #### Defined in
1186
-
1187
- [packages/ai-tool/src/tool-func.ts:342](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L342)
1188
-
1189
- ***
1190
-
1191
- ### list()?
1192
-
1193
- > `optional` **list**(`options`): `any`
1194
-
1195
- #### Parameters
1196
-
1197
- • **options**: [`ResClientFuncParams`](../interfaces/ResClientFuncParams.md)
1198
-
1199
- #### Returns
1200
-
1201
- `any`
1202
-
1203
- #### Inherited from
1204
-
1205
- [`ResClientTools`](ResClientTools.md).[`list`](ResClientTools.md#list)
1206
-
1207
- #### Defined in
1208
-
1209
- [packages/ai-tool/src/res-client-tools.ts:14](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/res-client-tools.ts#L14)
1210
-
1211
- ***
1212
-
1213
- ### mergeTo()
1214
-
1215
- > **mergeTo**(`dest`, `options`?): `any`
1216
-
1217
- Merge this attributes to dest object.
1218
-
1219
- #### Parameters
1220
-
1221
- • **dest**: `any`
1222
-
1223
- The destination object
1224
-
1225
- • **options?**: `IMergeOptions`
1226
-
1227
- #### Returns
1228
-
1229
- `any`
1230
-
1231
- the dest object.
1232
-
1233
- #### Inherited from
1234
-
1235
- [`ResClientTools`](ResClientTools.md).[`mergeTo`](ResClientTools.md#mergeto)
1236
-
1237
- #### Defined in
1238
-
1239
- node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:164
1240
-
1241
- ***
1242
-
1243
- ### obj2ArrParams()
1244
-
1245
- > **obj2ArrParams**(`params`?): `any`[]
1246
-
1247
- #### Parameters
1248
-
1249
- • **params?**: `any`
1250
-
1251
- #### Returns
1252
-
1253
- `any`[]
1254
-
1255
- #### Inherited from
1256
-
1257
- [`ResClientTools`](ResClientTools.md).[`obj2ArrParams`](ResClientTools.md#obj2arrparams)
1258
-
1259
- #### Defined in
1260
-
1261
- [packages/ai-tool/src/tool-func.ts:267](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L267)
1262
-
1263
- ***
1264
-
1265
- ### post()?
1266
-
1267
- > `optional` **post**(`options`): `any`
1268
-
1269
- #### Parameters
1270
-
1271
- • **options**: [`ResClientFuncParams`](../interfaces/ResClientFuncParams.md)
1272
-
1273
- #### Returns
1274
-
1275
- `any`
1276
-
1277
- #### Inherited from
1278
-
1279
- [`ResClientTools`](ResClientTools.md).[`post`](ResClientTools.md#post)
1280
-
1281
- #### Defined in
1282
-
1283
- [packages/ai-tool/src/res-client-tools.ts:11](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/res-client-tools.ts#L11)
1284
-
1285
- ***
1286
-
1287
- ### propertyIsEnumerable()
1288
-
1289
- > **propertyIsEnumerable**(`v`): `boolean`
1290
-
1291
- Determines whether a specified property is enumerable.
1292
-
1293
- #### Parameters
1294
-
1295
- • **v**: `PropertyKey`
1296
-
1297
- A property name.
1298
-
1299
- #### Returns
1300
-
1301
- `boolean`
1302
-
1303
- #### Inherited from
1304
-
1305
- [`ResClientTools`](ResClientTools.md).[`propertyIsEnumerable`](ResClientTools.md#propertyisenumerable)
1306
-
1307
- #### Defined in
1308
-
1309
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:152
1310
-
1311
- ***
1312
-
1313
- ### put()?
1314
-
1315
- > `optional` **put**(`__namedParameters`): `any`
1316
-
1317
- #### Parameters
1318
-
1319
- • **\_\_namedParameters**: [`ResClientFuncParams`](../interfaces/ResClientFuncParams.md)
1320
-
1321
- #### Returns
1322
-
1323
- `any`
1324
-
1325
- #### Inherited from
1326
-
1327
- [`ResClientTools`](ResClientTools.md).[`put`](ResClientTools.md#put)
1328
-
1329
- #### Defined in
1330
-
1331
- [packages/ai-tool/src/res-client-tools.ts:12](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/res-client-tools.ts#L12)
1332
-
1333
- ***
1334
-
1335
- ### register()
1336
-
1337
- > **register**(): `boolean` \| [`ToolFunc`](ToolFunc.md)
1338
-
1339
- #### Returns
1340
-
1341
- `boolean` \| [`ToolFunc`](ToolFunc.md)
1342
-
1343
- #### Inherited from
1344
-
1345
- [`ResClientTools`](ResClientTools.md).[`register`](ResClientTools.md#register)
1346
-
1347
- #### Defined in
1348
-
1349
- [packages/ai-tool/src/tool-func.ts:237](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L237)
1350
-
1351
- ***
1352
-
1353
- ### run()
1354
-
1355
- > **run**(`params`?): `Promise`\<`any`\>
1356
-
1357
- #### Parameters
1358
-
1359
- • **params?**: `any`
1360
-
1361
- #### Returns
1362
-
1363
- `Promise`\<`any`\>
1364
-
1365
- #### Inherited from
1366
-
1367
- [`ResClientTools`](ResClientTools.md).[`run`](ResClientTools.md#run)
1368
-
1369
- #### Defined in
1370
-
1371
- [packages/ai-tool/src/tool-func.ts:294](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L294)
1372
-
1373
- ***
1374
-
1375
- ### runAs()
1376
-
1377
- > **runAs**(`name`, `params`?): `Promise`\<`any`\>
1378
-
1379
- #### Parameters
1380
-
1381
- • **name**: `string`
1382
-
1383
- • **params?**: `any`
1384
-
1385
- #### Returns
1386
-
1387
- `Promise`\<`any`\>
1388
-
1389
- #### Inherited from
1390
-
1391
- [`ResClientTools`](ResClientTools.md).[`runAs`](ResClientTools.md#runas)
1392
-
1393
- #### Defined in
1394
-
1395
- [packages/ai-tool/src/tool-func.ts:298](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L298)
1396
-
1397
- ***
1398
-
1399
- ### runAsSync()
1400
-
1401
- > **runAsSync**(`name`, `params`?): `any`
1402
-
1403
- #### Parameters
1404
-
1405
- • **name**: `string`
1406
-
1407
- • **params?**: `any`
1408
-
1409
- #### Returns
1410
-
1411
- `any`
1412
-
1413
- #### Inherited from
1414
-
1415
- [`ResClientTools`](ResClientTools.md).[`runAsSync`](ResClientTools.md#runassync)
1416
-
1417
- #### Defined in
1418
-
1419
- [packages/ai-tool/src/tool-func.ts:302](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L302)
1420
-
1421
- ***
1422
-
1423
- ### runSync()
1424
-
1425
- > **runSync**(`params`?): `any`
1426
-
1427
- #### Parameters
1428
-
1429
- • **params?**: `any`
1430
-
1431
- #### Returns
1432
-
1433
- `any`
1434
-
1435
- #### Inherited from
1436
-
1437
- [`ResClientTools`](ResClientTools.md).[`runSync`](ResClientTools.md#runsync)
1438
-
1439
- #### Defined in
1440
-
1441
- [packages/ai-tool/src/tool-func.ts:280](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L280)
1442
-
1443
- ***
1444
-
1445
- ### runWithPos()
1446
-
1447
- > **runWithPos**(...`params`): `Promise`\<`any`\>
1448
-
1449
- #### Parameters
1450
-
1451
- • ...**params**: `any`[]
1452
-
1453
- #### Returns
1454
-
1455
- `Promise`\<`any`\>
1456
-
1457
- #### Inherited from
1458
-
1459
- [`ResClientTools`](ResClientTools.md).[`runWithPos`](ResClientTools.md#runwithpos)
1460
-
1461
- #### Defined in
1462
-
1463
- [packages/ai-tool/src/tool-func.ts:323](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L323)
1464
-
1465
- ***
1466
-
1467
- ### runWithPosAs()
1468
-
1469
- > **runWithPosAs**(`name`, ...`params`): `Promise`\<`any`\>
1470
-
1471
- #### Parameters
1472
-
1473
- • **name**: `string`
1474
-
1475
- • ...**params**: `any`[]
1476
-
1477
- #### Returns
1478
-
1479
- `Promise`\<`any`\>
1480
-
1481
- #### Inherited from
1482
-
1483
- [`ResClientTools`](ResClientTools.md).[`runWithPosAs`](ResClientTools.md#runwithposas)
1484
-
1485
- #### Defined in
1486
-
1487
- [packages/ai-tool/src/tool-func.ts:327](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L327)
1488
-
1489
- ***
1490
-
1491
- ### runWithPosAsSync()
1492
-
1493
- > **runWithPosAsSync**(`name`, ...`params`): `any`
1494
-
1495
- #### Parameters
1496
-
1497
- • **name**: `string`
1498
-
1499
- • ...**params**: `any`[]
1500
-
1501
- #### Returns
1502
-
1503
- `any`
1504
-
1505
- #### Inherited from
1506
-
1507
- [`ResClientTools`](ResClientTools.md).[`runWithPosAsSync`](ResClientTools.md#runwithposassync)
1508
-
1509
- #### Defined in
1510
-
1511
- [packages/ai-tool/src/tool-func.ts:319](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L319)
1512
-
1513
- ***
1514
-
1515
- ### runWithPosSync()
1516
-
1517
- > **runWithPosSync**(...`params`): `any`
1518
-
1519
- #### Parameters
1520
-
1521
- • ...**params**: `any`[]
1522
-
1523
- #### Returns
1524
-
1525
- `any`
1526
-
1527
- #### Inherited from
1528
-
1529
- [`ResClientTools`](ResClientTools.md).[`runWithPosSync`](ResClientTools.md#runwithpossync)
1530
-
1531
- #### Defined in
1532
-
1533
- [packages/ai-tool/src/tool-func.ts:312](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L312)
1534
-
1535
- ***
1536
-
1537
- ### subscribe()
1538
-
1539
- > **subscribe**(`events`): `Promise`\<`any`\>
1540
-
1541
- subscribe server sent event(SSE)
1542
-
1543
- #### Parameters
1544
-
1545
- • **events**: `string` \| `string`[]
1546
-
1547
- #### Returns
1548
-
1549
- `Promise`\<`any`\>
1550
-
1551
- #### Defined in
1552
-
1553
- [packages/ai-tool/src/funcs/event-client.ts:98](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/funcs/event-client.ts#L98)
1554
-
1555
- ***
1556
-
1557
- ### toJSON()
1558
-
1559
- > **toJSON**(): `any`
1560
-
1561
- #### Returns
1562
-
1563
- `any`
1564
-
1565
- #### Inherited from
1566
-
1567
- [`ResClientTools`](ResClientTools.md).[`toJSON`](ResClientTools.md#tojson)
1568
-
1569
- #### Defined in
1570
-
1571
- node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:182
1572
-
1573
- ***
1574
-
1575
- ### toLocaleString()
1576
-
1577
- > **toLocaleString**(): `string`
1578
-
1579
- Returns a date converted to a string using the current locale.
1580
-
1581
- #### Returns
1582
-
1583
- `string`
1584
-
1585
- #### Inherited from
1586
-
1587
- [`ResClientTools`](ResClientTools.md).[`toLocaleString`](ResClientTools.md#tolocalestring)
1588
-
1589
- #### Defined in
1590
-
1591
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:131
1592
-
1593
- ***
1594
-
1595
- ### toObject()
1596
-
1597
- > **toObject**(`options`?): `any`
1598
-
1599
- Convert the attributes to the json object
1600
-
1601
- #### Parameters
1602
-
1603
- • **options?**: `any`
1604
-
1605
- #### Returns
1606
-
1607
- `any`
1608
-
1609
- the json object.
1610
-
1611
- #### Inherited from
1612
-
1613
- [`ResClientTools`](ResClientTools.md).[`toObject`](ResClientTools.md#toobject)
1614
-
1615
- #### Defined in
1616
-
1617
- node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:181
1618
-
1619
- ***
1620
-
1621
- ### toString()
1622
-
1623
- > **toString**(): `string`
1624
-
1625
- Returns a string representation of an object.
1626
-
1627
- #### Returns
1628
-
1629
- `string`
1630
-
1631
- #### Inherited from
1632
-
1633
- [`ResClientTools`](ResClientTools.md).[`toString`](ResClientTools.md#tostring)
1634
-
1635
- #### Defined in
1636
-
1637
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:128
1638
-
1639
- ***
1640
-
1641
- ### unforwardEvent()
1642
-
1643
- > **unforwardEvent**(`events`): `void`
1644
-
1645
- unforward local event(s) to server
1646
-
1647
- unsubscribe these local events not to forward/publish to server
1648
-
1649
- Note: pls backendEventable(ClientTools or EventClient) first
1650
-
1651
- #### Parameters
1652
-
1653
- • **events**: `string` \| `string`[]
1654
-
1655
- #### Returns
1656
-
1657
- `void`
1658
-
1659
- #### Defined in
1660
-
1661
- [packages/ai-tool/src/funcs/event-client.ts:160](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/funcs/event-client.ts#L160)
1662
-
1663
- ***
1664
-
1665
- ### unregister()
1666
-
1667
- > **unregister**(): `any`
1668
-
1669
- #### Returns
1670
-
1671
- `any`
1672
-
1673
- #### Inherited from
1674
-
1675
- [`ResClientTools`](ResClientTools.md).[`unregister`](ResClientTools.md#unregister)
1676
-
1677
- #### Defined in
1678
-
1679
- [packages/ai-tool/src/tool-func.ts:250](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L250)
1680
-
1681
- ***
1682
-
1683
- ### unsubscribe()
1684
-
1685
- > **unsubscribe**(`events`): `Promise`\<`any`\>
1686
-
1687
- unsubscribe server sent event(SSE)
1688
-
1689
- #### Parameters
1690
-
1691
- • **events**: `string` \| `string`[]
1692
-
1693
- #### Returns
1694
-
1695
- `Promise`\<`any`\>
1696
-
1697
- #### Defined in
1698
-
1699
- [packages/ai-tool/src/funcs/event-client.ts:117](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/funcs/event-client.ts#L117)
1700
-
1701
- ***
1702
-
1703
- ### valueOf()
1704
-
1705
- > **valueOf**(): `Object`
1706
-
1707
- Returns the primitive value of the specified object.
1708
-
1709
- #### Returns
1710
-
1711
- `Object`
1712
-
1713
- #### Inherited from
1714
-
1715
- [`ResClientTools`](ResClientTools.md).[`valueOf`](ResClientTools.md#valueof)
1716
-
1717
- #### Defined in
1718
-
1719
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:134
1720
-
1721
- ***
1722
-
1723
- ### assign()
1724
-
1725
- #### assign(target, source)
1726
-
1727
- > `static` **assign**\<`T`, `U`\>(`target`, `source`): `T` & `U`
1728
-
1729
- Copy the values of all of the enumerable own properties from one or more source objects to a
1730
- target object. Returns the target object.
1731
-
1732
- ##### Type Parameters
1733
-
1734
- • **T** *extends* `object`
1735
-
1736
- • **U**
1737
-
1738
- ##### Parameters
1739
-
1740
- • **target**: `T`
1741
-
1742
- The target object to copy to.
1743
-
1744
- • **source**: `U`
1745
-
1746
- The source object from which to copy properties.
1747
-
1748
- ##### Returns
1749
-
1750
- `T` & `U`
1751
-
1752
- ##### Inherited from
1753
-
1754
- [`ResClientTools`](ResClientTools.md).[`assign`](ResClientTools.md#assign-2)
1755
-
1756
- ##### Defined in
1757
-
1758
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:286
1759
-
1760
- #### assign(target, source1, source2)
1761
-
1762
- > `static` **assign**\<`T`, `U`, `V`\>(`target`, `source1`, `source2`): `T` & `U` & `V`
1763
-
1764
- Copy the values of all of the enumerable own properties from one or more source objects to a
1765
- target object. Returns the target object.
1766
-
1767
- ##### Type Parameters
1768
-
1769
- • **T** *extends* `object`
1770
-
1771
- • **U**
1772
-
1773
- • **V**
1774
-
1775
- ##### Parameters
1776
-
1777
- • **target**: `T`
1778
-
1779
- The target object to copy to.
1780
-
1781
- • **source1**: `U`
1782
-
1783
- The first source object from which to copy properties.
1784
-
1785
- • **source2**: `V`
1786
-
1787
- The second source object from which to copy properties.
1788
-
1789
- ##### Returns
1790
-
1791
- `T` & `U` & `V`
1792
-
1793
- ##### Inherited from
1794
-
1795
- [`ResClientTools`](ResClientTools.md).[`assign`](ResClientTools.md#assign-2)
1796
-
1797
- ##### Defined in
1798
-
1799
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:295
1800
-
1801
- #### assign(target, source1, source2, source3)
1802
-
1803
- > `static` **assign**\<`T`, `U`, `V`, `W`\>(`target`, `source1`, `source2`, `source3`): `T` & `U` & `V` & `W`
1804
-
1805
- Copy the values of all of the enumerable own properties from one or more source objects to a
1806
- target object. Returns the target object.
1807
-
1808
- ##### Type Parameters
1809
-
1810
- • **T** *extends* `object`
1811
-
1812
- • **U**
1813
-
1814
- • **V**
1815
-
1816
- • **W**
1817
-
1818
- ##### Parameters
1819
-
1820
- • **target**: `T`
1821
-
1822
- The target object to copy to.
1823
-
1824
- • **source1**: `U`
1825
-
1826
- The first source object from which to copy properties.
1827
-
1828
- • **source2**: `V`
1829
-
1830
- The second source object from which to copy properties.
1831
-
1832
- • **source3**: `W`
1833
-
1834
- The third source object from which to copy properties.
1835
-
1836
- ##### Returns
1837
-
1838
- `T` & `U` & `V` & `W`
1839
-
1840
- ##### Inherited from
1841
-
1842
- [`ResClientTools`](ResClientTools.md).[`assign`](ResClientTools.md#assign-2)
1843
-
1844
- ##### Defined in
1845
-
1846
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:305
1847
-
1848
- #### assign(target, sources)
1849
-
1850
- > `static` **assign**(`target`, ...`sources`): `any`
1851
-
1852
- Copy the values of all of the enumerable own properties from one or more source objects to a
1853
- target object. Returns the target object.
1854
-
1855
- ##### Parameters
1856
-
1857
- • **target**: `object`
1858
-
1859
- The target object to copy to.
1860
-
1861
- • ...**sources**: `any`[]
1862
-
1863
- One or more source objects from which to copy properties
1864
-
1865
- ##### Returns
1866
-
1867
- `any`
1868
-
1869
- ##### Inherited from
1870
-
1871
- [`ResClientTools`](ResClientTools.md).[`assign`](ResClientTools.md#assign-2)
1872
-
1873
- ##### Defined in
1874
-
1875
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:313
1876
-
1877
- ***
1878
-
1879
- ### create()
1880
-
1881
- #### create(o)
1882
-
1883
- > `static` **create**(`o`): `any`
1884
-
1885
- Creates an object that has the specified prototype or that has null prototype.
1886
-
1887
- ##### Parameters
1888
-
1889
- • **o**: `null` \| `object`
1890
-
1891
- Object to use as a prototype. May be null.
1892
-
1893
- ##### Returns
1894
-
1895
- `any`
1896
-
1897
- ##### Inherited from
1898
-
1899
- [`ResClientTools`](ResClientTools.md).[`create`](ResClientTools.md#create)
1900
-
1901
- ##### Defined in
1902
-
1903
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:188
1904
-
1905
- #### create(o, properties)
1906
-
1907
- > `static` **create**(`o`, `properties`): `any`
1908
-
1909
- Creates an object that has the specified prototype, and that optionally contains specified properties.
1910
-
1911
- ##### Parameters
1912
-
1913
- • **o**: `null` \| `object`
1914
-
1915
- Object to use as a prototype. May be null
1916
-
1917
- • **properties**: `PropertyDescriptorMap` & `ThisType`\<`any`\>
1918
-
1919
- JavaScript object that contains one or more property descriptors.
1920
-
1921
- ##### Returns
1922
-
1923
- `any`
1924
-
1925
- ##### Inherited from
1926
-
1927
- [`ResClientTools`](ResClientTools.md).[`create`](ResClientTools.md#create)
1928
-
1929
- ##### Defined in
1930
-
1931
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:195
1932
-
1933
- ***
1934
-
1935
- ### defineProperties()
1936
-
1937
- > `static` **defineProperties**(`aTarget`, `aProperties`, `recreate`?): `any`
1938
-
1939
- Adds one or more properties to an object, and/or modifies attributes of existing properties.
1940
-
1941
- #### Parameters
1942
-
1943
- • **aTarget**: `any`
1944
-
1945
- • **aProperties**: `PropDescriptors`
1946
-
1947
- • **recreate?**: `boolean`
1948
-
1949
- #### Returns
1950
-
1951
- `any`
1952
-
1953
- #### Inherited from
1954
-
1955
- [`ResClientTools`](ResClientTools.md).[`defineProperties`](ResClientTools.md#defineproperties-1)
1956
-
1957
- #### Defined in
1958
-
1959
- node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/advance.d.ts:11
1960
-
1961
- ***
1962
-
1963
- ### defineProperty()
1964
-
1965
- > `static` **defineProperty**\<`T`\>(`o`, `p`, `attributes`): `T`
1966
-
1967
- Adds a property to an object, or modifies attributes of an existing property.
1968
-
1969
- #### Type Parameters
1970
-
1971
- • **T**
1972
-
1973
- #### Parameters
1974
-
1975
- • **o**: `T`
1976
-
1977
- 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.
1978
-
1979
- • **p**: `PropertyKey`
1980
-
1981
- The property name.
1982
-
1983
- • **attributes**: `PropertyDescriptor` & `ThisType`\<`any`\>
1984
-
1985
- Descriptor for the property. It can be for a data property or an accessor property.
1986
-
1987
- #### Returns
1988
-
1989
- `T`
1990
-
1991
- #### Inherited from
1992
-
1993
- [`ResClientTools`](ResClientTools.md).[`defineProperty`](ResClientTools.md#defineproperty)
1994
-
1995
- #### Defined in
1996
-
1997
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:203
1998
-
1999
- ***
2000
-
2001
- ### entries()
2002
-
2003
- #### entries(o)
2004
-
2005
- > `static` **entries**\<`T`\>(`o`): [`string`, `T`][]
2006
-
2007
- Returns an array of key/values of the enumerable own properties of an object
2008
-
2009
- ##### Type Parameters
2010
-
2011
- • **T**
2012
-
2013
- ##### Parameters
2014
-
2015
- • **o**: `object` \| `ArrayLike`\<`T`\>
2016
-
2017
- Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.
2018
-
2019
- ##### Returns
2020
-
2021
- [`string`, `T`][]
2022
-
2023
- ##### Inherited from
2024
-
2025
- [`ResClientTools`](ResClientTools.md).[`entries`](ResClientTools.md#entries)
2026
-
2027
- ##### Defined in
2028
-
2029
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es2017.object.d.ts:36
2030
-
2031
- #### entries(o)
2032
-
2033
- > `static` **entries**(`o`): [`string`, `any`][]
2034
-
2035
- Returns an array of key/values of the enumerable own properties of an object
2036
-
2037
- ##### Parameters
2038
-
2039
- • **o**
2040
-
2041
- Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.
2042
-
2043
- ##### Returns
2044
-
2045
- [`string`, `any`][]
2046
-
2047
- ##### Inherited from
2048
-
2049
- [`ResClientTools`](ResClientTools.md).[`entries`](ResClientTools.md#entries)
2050
-
2051
- ##### Defined in
2052
-
2053
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es2017.object.d.ts:42
2054
-
2055
- ***
2056
-
2057
- ### fetch()
2058
-
2059
- > `static` **fetch**(`name`, `objParam`?): `Promise`\<`any`\>
2060
-
2061
- #### Parameters
2062
-
2063
- • **name**: `string`
2064
-
2065
- • **objParam?**: `any`
2066
-
2067
- #### Returns
2068
-
2069
- `Promise`\<`any`\>
2070
-
2071
- #### Inherited from
2072
-
2073
- [`ResClientTools`](ResClientTools.md).[`fetch`](ResClientTools.md#fetch-1)
2074
-
2075
- #### Defined in
2076
-
2077
- [packages/ai-tool/src/client-tools.ts:56](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/client-tools.ts#L56)
2078
-
2079
- ***
2080
-
2081
- ### freeze()
2082
-
2083
- #### freeze(f)
2084
-
2085
- > `static` **freeze**\<`T`\>(`f`): `T`
2086
-
2087
- Prevents the modification of existing property attributes and values, and prevents the addition of new properties.
2088
-
2089
- ##### Type Parameters
2090
-
2091
- • **T** *extends* `Function`
2092
-
2093
- ##### Parameters
2094
-
2095
- • **f**: `T`
2096
-
2097
- Object on which to lock the attributes.
2098
-
2099
- ##### Returns
2100
-
2101
- `T`
2102
-
2103
- ##### Inherited from
2104
-
2105
- [`ResClientTools`](ResClientTools.md).[`freeze`](ResClientTools.md#freeze)
2106
-
2107
- ##### Defined in
2108
-
2109
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:222
2110
-
2111
- #### freeze(o)
2112
-
2113
- > `static` **freeze**\<`T`, `U`\>(`o`): `Readonly`\<`T`\>
2114
-
2115
- Prevents the modification of existing property attributes and values, and prevents the addition of new properties.
2116
-
2117
- ##### Type Parameters
2118
-
2119
- • **T** *extends* `object`
2120
-
2121
- • **U** *extends* `string` \| `number` \| `bigint` \| `boolean` \| `symbol`
2122
-
2123
- ##### Parameters
2124
-
2125
- • **o**: `T`
2126
-
2127
- Object on which to lock the attributes.
2128
-
2129
- ##### Returns
2130
-
2131
- `Readonly`\<`T`\>
2132
-
2133
- ##### Inherited from
2134
-
2135
- [`ResClientTools`](ResClientTools.md).[`freeze`](ResClientTools.md#freeze)
2136
-
2137
- ##### Defined in
2138
-
2139
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:228
2140
-
2141
- #### freeze(o)
2142
-
2143
- > `static` **freeze**\<`T`\>(`o`): `Readonly`\<`T`\>
2144
-
2145
- Prevents the modification of existing property attributes and values, and prevents the addition of new properties.
2146
-
2147
- ##### Type Parameters
2148
-
2149
- • **T**
2150
-
2151
- ##### Parameters
2152
-
2153
- • **o**: `T`
2154
-
2155
- Object on which to lock the attributes.
2156
-
2157
- ##### Returns
2158
-
2159
- `Readonly`\<`T`\>
2160
-
2161
- ##### Inherited from
2162
-
2163
- [`ResClientTools`](ResClientTools.md).[`freeze`](ResClientTools.md#freeze)
2164
-
2165
- ##### Defined in
2166
-
2167
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:234
2168
-
2169
- ***
2170
-
2171
- ### fromEntries()
2172
-
2173
- #### fromEntries(entries)
2174
-
2175
- > `static` **fromEntries**\<`T`\>(`entries`): `object`
2176
-
2177
- Returns an object created by key-value entries for properties and methods
2178
-
2179
- ##### Type Parameters
2180
-
2181
- • **T** = `any`
2182
-
2183
- ##### Parameters
2184
-
2185
- • **entries**: `Iterable`\<readonly [`PropertyKey`, `T`], `any`, `any`\>
2186
-
2187
- An iterable object that contains key-value entries for properties and methods.
2188
-
2189
- ##### Returns
2190
-
2191
- `object`
2192
-
2193
- ##### Inherited from
2194
-
2195
- [`ResClientTools`](ResClientTools.md).[`fromEntries`](ResClientTools.md#fromentries)
2196
-
2197
- ##### Defined in
2198
-
2199
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es2019.object.d.ts:26
2200
-
2201
- #### fromEntries(entries)
2202
-
2203
- > `static` **fromEntries**(`entries`): `any`
2204
-
2205
- Returns an object created by key-value entries for properties and methods
2206
-
2207
- ##### Parameters
2208
-
2209
- • **entries**: `Iterable`\<readonly `any`[], `any`, `any`\>
2210
-
2211
- An iterable object that contains key-value entries for properties and methods.
2212
-
2213
- ##### Returns
2214
-
2215
- `any`
2216
-
2217
- ##### Inherited from
2218
-
2219
- [`ResClientTools`](ResClientTools.md).[`fromEntries`](ResClientTools.md#fromentries)
2220
-
2221
- ##### Defined in
2222
-
2223
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es2019.object.d.ts:32
2224
-
2225
- ***
2226
-
2227
- ### get()
2228
-
2229
- > `static` **get**(`name`): [`ToolFunc`](ToolFunc.md)
2230
-
2231
- #### Parameters
2232
-
2233
- • **name**: `string`
2234
-
2235
- #### Returns
2236
-
2237
- [`ToolFunc`](ToolFunc.md)
2238
-
2239
- #### Inherited from
2240
-
2241
- [`ResClientTools`](ResClientTools.md).[`get`](ResClientTools.md#get-1)
2242
-
2243
- #### Defined in
2244
-
2245
- [packages/ai-tool/src/tool-func.ts:77](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L77)
2246
-
2247
- ***
2248
-
2249
- ### getAllByTag()
2250
-
2251
- > `static` **getAllByTag**(`tagName`): [`ToolFunc`](ToolFunc.md)[]
2252
-
2253
- #### Parameters
2254
-
2255
- • **tagName**: `string`
2256
-
2257
- #### Returns
2258
-
2259
- [`ToolFunc`](ToolFunc.md)[]
2260
-
2261
- #### Inherited from
2262
-
2263
- [`ResClientTools`](ResClientTools.md).[`getAllByTag`](ResClientTools.md#getallbytag)
2264
-
2265
- #### Defined in
2266
-
2267
- [packages/ai-tool/src/tool-func.ts:105](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L105)
2268
-
2269
- ***
2270
-
2271
- ### getByTag()
2272
-
2273
- > `static` **getByTag**(`tagName`): `undefined` \| [`ToolFunc`](ToolFunc.md)
2274
-
2275
- #### Parameters
2276
-
2277
- • **tagName**: `string`
2278
-
2279
- #### Returns
2280
-
2281
- `undefined` \| [`ToolFunc`](ToolFunc.md)
2282
-
2283
- #### Inherited from
2284
-
2285
- [`ResClientTools`](ResClientTools.md).[`getByTag`](ResClientTools.md#getbytag)
2286
-
2287
- #### Defined in
2288
-
2289
- [packages/ai-tool/src/tool-func.ts:85](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L85)
2290
-
2291
- ***
2292
-
2293
- ### getFunc()
2294
-
2295
- > `static` **getFunc**(`name`): `any`
2296
-
2297
- #### Parameters
2298
-
2299
- • **name**: `string`
2300
-
2301
- #### Returns
2302
-
2303
- `any`
2304
-
2305
- #### Inherited from
2306
-
2307
- [`ResClientTools`](ResClientTools.md).[`getFunc`](ResClientTools.md#getfunc-1)
2308
-
2309
- #### Defined in
2310
-
2311
- [packages/ai-tool/src/tool-func.ts:146](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L146)
2312
-
2313
- ***
2314
-
2315
- ### getFuncWithPos()
2316
-
2317
- > `static` **getFuncWithPos**(`name`): `any`
2318
-
2319
- #### Parameters
2320
-
2321
- • **name**: `string`
2322
-
2323
- #### Returns
2324
-
2325
- `any`
2326
-
2327
- #### Inherited from
2328
-
2329
- [`ResClientTools`](ResClientTools.md).[`getFuncWithPos`](ResClientTools.md#getfuncwithpos-1)
2330
-
2331
- #### Defined in
2332
-
2333
- [packages/ai-tool/src/tool-func.ts:167](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L167)
2334
-
2335
- ***
2336
-
2337
- ### getOwnPropertyDescriptor()
2338
-
2339
- > `static` **getOwnPropertyDescriptor**(`o`, `p`): `undefined` \| `PropertyDescriptor`
2340
-
2341
- Gets the own property descriptor of the specified object.
2342
- An own property descriptor is one that is defined directly on the object and is not inherited from the object's prototype.
2343
-
2344
- #### Parameters
2345
-
2346
- • **o**: `any`
2347
-
2348
- Object that contains the property.
2349
-
2350
- • **p**: `PropertyKey`
2351
-
2352
- Name of the property.
2353
-
2354
- #### Returns
2355
-
2356
- `undefined` \| `PropertyDescriptor`
2357
-
2358
- #### Inherited from
2359
-
2360
- [`ResClientTools`](ResClientTools.md).[`getOwnPropertyDescriptor`](ResClientTools.md#getownpropertydescriptor)
2361
-
2362
- #### Defined in
2363
-
2364
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:175
2365
-
2366
- ***
2367
-
2368
- ### getOwnPropertyDescriptors()
2369
-
2370
- > `static` **getOwnPropertyDescriptors**\<`T`\>(`o`): \{ \[P in string \| number \| symbol\]: TypedPropertyDescriptor\<T\[P\]\> \} & `object`
2371
-
2372
- Returns an object containing all own property descriptors of an object
2373
-
2374
- #### Type Parameters
2375
-
2376
- • **T**
2377
-
2378
- #### Parameters
2379
-
2380
- • **o**: `T`
2381
-
2382
- Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.
2383
-
2384
- #### Returns
2385
-
2386
- \{ \[P in string \| number \| symbol\]: TypedPropertyDescriptor\<T\[P\]\> \} & `object`
2387
-
2388
- #### Inherited from
2389
-
2390
- [`ResClientTools`](ResClientTools.md).[`getOwnPropertyDescriptors`](ResClientTools.md#getownpropertydescriptors)
2391
-
2392
- #### Defined in
2393
-
2394
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es2017.object.d.ts:48
2395
-
2396
- ***
2397
-
2398
- ### getOwnPropertyNames()
2399
-
2400
- > `static` **getOwnPropertyNames**(`o`): `string`[]
2401
-
2402
- Returns the names of the own properties of an object. The own properties of an object are those that are defined directly
2403
- on that object, and are not inherited from the object's prototype. The properties of an object include both fields (objects) and functions.
2404
-
2405
- #### Parameters
2406
-
2407
- • **o**: `any`
2408
-
2409
- Object that contains the own properties.
2410
-
2411
- #### Returns
2412
-
2413
- `string`[]
2414
-
2415
- #### Inherited from
2416
-
2417
- [`ResClientTools`](ResClientTools.md).[`getOwnPropertyNames`](ResClientTools.md#getownpropertynames)
2418
-
2419
- #### Defined in
2420
-
2421
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:182
2422
-
2423
- ***
2424
-
2425
- ### getOwnPropertySymbols()
2426
-
2427
- > `static` **getOwnPropertySymbols**(`o`): `symbol`[]
2428
-
2429
- Returns an array of all symbol properties found directly on object o.
2430
-
2431
- #### Parameters
2432
-
2433
- • **o**: `any`
2434
-
2435
- Object to retrieve the symbols from.
2436
-
2437
- #### Returns
2438
-
2439
- `symbol`[]
2440
-
2441
- #### Inherited from
2442
-
2443
- [`ResClientTools`](ResClientTools.md).[`getOwnPropertySymbols`](ResClientTools.md#getownpropertysymbols)
2444
-
2445
- #### Defined in
2446
-
2447
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:319
2448
-
2449
- ***
2450
-
2451
- ### getProperties()
2452
-
2453
- > `static` **getProperties**(): `PropDescriptors`
2454
-
2455
- get all properties descriptor include inherited.
2456
-
2457
- #### Returns
2458
-
2459
- `PropDescriptors`
2460
-
2461
- #### Inherited from
2462
-
2463
- [`ResClientTools`](ResClientTools.md).[`getProperties`](ResClientTools.md#getproperties-1)
2464
-
2465
- #### Defined in
2466
-
2467
- node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/advance.d.ts:10
2468
-
2469
- ***
2470
-
2471
- ### getPrototypeOf()
2472
-
2473
- > `static` **getPrototypeOf**(`o`): `any`
2474
-
2475
- Returns the prototype of an object.
2476
-
2477
- #### Parameters
2478
-
2479
- • **o**: `any`
2480
-
2481
- The object that references the prototype.
2482
-
2483
- #### Returns
2484
-
2485
- `any`
2486
-
2487
- #### Inherited from
2488
-
2489
- [`ResClientTools`](ResClientTools.md).[`getPrototypeOf`](ResClientTools.md#getprototypeof)
2490
-
2491
- #### Defined in
2492
-
2493
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:167
2494
-
2495
- ***
2496
-
2497
- ### hasAsyncFeature()
2498
-
2499
- > `static` **hasAsyncFeature**(`feature`): `boolean`
2500
-
2501
- #### Parameters
2502
-
2503
- • **feature**: [`AsyncFeatureBits`](../enumerations/AsyncFeatureBits.md)
2504
-
2505
- #### Returns
2506
-
2507
- `boolean`
2508
-
2509
- #### Inherited from
2510
-
2511
- [`ResClientTools`](ResClientTools.md).[`hasAsyncFeature`](ResClientTools.md#hasasyncfeature-1)
2512
-
2513
- #### Defined in
2514
-
2515
- [packages/ai-tool/src/tool-func.ts:123](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L123)
2516
-
2517
- ***
2518
-
2519
- ### hasOwn()
2520
-
2521
- > `static` **hasOwn**(`o`, `v`): `boolean`
2522
-
2523
- Determines whether an object has a property with the specified name.
2524
-
2525
- #### Parameters
2526
-
2527
- • **o**: `object`
2528
-
2529
- An object.
2530
-
2531
- • **v**: `PropertyKey`
2532
-
2533
- A property name.
2534
-
2535
- #### Returns
2536
-
2537
- `boolean`
2538
-
2539
- #### Inherited from
2540
-
2541
- [`ResClientTools`](ResClientTools.md).[`hasOwn`](ResClientTools.md#hasown)
2542
-
2543
- #### Defined in
2544
-
2545
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es2022.object.d.ts:25
2546
-
2547
- ***
2548
-
2549
- ### is()
2550
-
2551
- > `static` **is**(`value1`, `value2`): `boolean`
2552
-
2553
- Returns true if the values are the same value, false otherwise.
2554
-
2555
- #### Parameters
2556
-
2557
- • **value1**: `any`
2558
-
2559
- The first value.
2560
-
2561
- • **value2**: `any`
2562
-
2563
- The second value.
2564
-
2565
- #### Returns
2566
-
2567
- `boolean`
2568
-
2569
- #### Inherited from
2570
-
2571
- [`ResClientTools`](ResClientTools.md).[`is`](ResClientTools.md#is)
2572
-
2573
- #### Defined in
2574
-
2575
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:332
2576
-
2577
- ***
2578
-
2579
- ### isExtensible()
2580
-
2581
- > `static` **isExtensible**(`o`): `boolean`
2582
-
2583
- Returns a value that indicates whether new properties can be added to an object.
2584
-
2585
- #### Parameters
2586
-
2587
- • **o**: `any`
2588
-
2589
- Object to test.
2590
-
2591
- #### Returns
2592
-
2593
- `boolean`
2594
-
2595
- #### Inherited from
2596
-
2597
- [`ResClientTools`](ResClientTools.md).[`isExtensible`](ResClientTools.md#isextensible)
2598
-
2599
- #### Defined in
2600
-
2601
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:258
2602
-
2603
- ***
2604
-
2605
- ### isFrozen()
2606
-
2607
- > `static` **isFrozen**(`o`): `boolean`
2608
-
2609
- Returns true if existing property attributes and values cannot be modified in an object, and new properties cannot be added to the object.
2610
-
2611
- #### Parameters
2612
-
2613
- • **o**: `any`
2614
-
2615
- Object to test.
2616
-
2617
- #### Returns
2618
-
2619
- `boolean`
2620
-
2621
- #### Inherited from
2622
-
2623
- [`ResClientTools`](ResClientTools.md).[`isFrozen`](ResClientTools.md#isfrozen)
2624
-
2625
- #### Defined in
2626
-
2627
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:252
2628
-
2629
- ***
2630
-
2631
- ### isSealed()
2632
-
2633
- > `static` **isSealed**(`o`): `boolean`
2634
-
2635
- Returns true if existing property attributes cannot be modified in an object and new properties cannot be added to the object.
2636
-
2637
- #### Parameters
2638
-
2639
- • **o**: `any`
2640
-
2641
- Object to test.
2642
-
2643
- #### Returns
2644
-
2645
- `boolean`
2646
-
2647
- #### Inherited from
2648
-
2649
- [`ResClientTools`](ResClientTools.md).[`isSealed`](ResClientTools.md#issealed)
2650
-
2651
- #### Defined in
2652
-
2653
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:246
2654
-
2655
- ***
2656
-
2657
- ### keys()
2658
-
2659
- #### keys(o)
2660
-
2661
- > `static` **keys**(`o`): `string`[]
2662
-
2663
- Returns the names of the enumerable string properties and methods of an object.
2664
-
2665
- ##### Parameters
2666
-
2667
- • **o**: `object`
2668
-
2669
- Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.
2670
-
2671
- ##### Returns
2672
-
2673
- `string`[]
2674
-
2675
- ##### Inherited from
2676
-
2677
- [`ResClientTools`](ResClientTools.md).[`keys`](ResClientTools.md#keys)
2678
-
2679
- ##### Defined in
2680
-
2681
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:264
2682
-
2683
- #### keys(o)
2684
-
2685
- > `static` **keys**(`o`): `string`[]
2686
-
2687
- Returns the names of the enumerable string properties and methods of an object.
2688
-
2689
- ##### Parameters
2690
-
2691
- • **o**
2692
-
2693
- Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.
2694
-
2695
- ##### Returns
2696
-
2697
- `string`[]
2698
-
2699
- ##### Inherited from
2700
-
2701
- [`ResClientTools`](ResClientTools.md).[`keys`](ResClientTools.md#keys)
2702
-
2703
- ##### Defined in
2704
-
2705
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:325
2706
-
2707
- ***
2708
-
2709
- ### list()
2710
-
2711
- > `static` **list**(): [`Funcs`](../interfaces/Funcs.md)
2712
-
2713
- #### Returns
2714
-
2715
- [`Funcs`](../interfaces/Funcs.md)
2716
-
2717
- #### Inherited from
2718
-
2719
- [`ResClientTools`](ResClientTools.md).[`list`](ResClientTools.md#list-1)
2720
-
2721
- #### Defined in
2722
-
2723
- [packages/ai-tool/src/tool-func.ts:81](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L81)
2724
-
2725
- ***
2726
-
2727
- ### loadFrom()
2728
-
2729
- > `static` **loadFrom**(): `Promise`\<`void`\>
2730
-
2731
- #### Returns
2732
-
2733
- `Promise`\<`void`\>
2734
-
2735
- #### Inherited from
2736
-
2737
- [`ResClientTools`](ResClientTools.md).[`loadFrom`](ResClientTools.md#loadfrom)
2738
-
2739
- #### Defined in
2740
-
2741
- [packages/ai-tool/src/client-tools.ts:29](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/client-tools.ts#L29)
2742
-
2743
- ***
2744
-
2745
- ### loadFromSync()
2746
-
2747
- > `static` **loadFromSync**(`items`): `void`
2748
-
2749
- #### Parameters
2750
-
2751
- • **items**: [`Funcs`](../interfaces/Funcs.md)
2752
-
2753
- #### Returns
2754
-
2755
- `void`
2756
-
2757
- #### Inherited from
2758
-
2759
- [`ResClientTools`](ResClientTools.md).[`loadFromSync`](ResClientTools.md#loadfromsync)
2760
-
2761
- #### Defined in
2762
-
2763
- [packages/ai-tool/src/client-tools.ts:41](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/client-tools.ts#L41)
2764
-
2765
- ***
2766
-
2767
- ### preventExtensions()
2768
-
2769
- > `static` **preventExtensions**\<`T`\>(`o`): `T`
2770
-
2771
- Prevents the addition of new properties to an object.
2772
-
2773
- #### Type Parameters
2774
-
2775
- • **T**
2776
-
2777
- #### Parameters
2778
-
2779
- • **o**: `T`
2780
-
2781
- Object to make non-extensible.
2782
-
2783
- #### Returns
2784
-
2785
- `T`
2786
-
2787
- #### Inherited from
2788
-
2789
- [`ResClientTools`](ResClientTools.md).[`preventExtensions`](ResClientTools.md#preventextensions)
2790
-
2791
- #### Defined in
2792
-
2793
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:240
2794
-
2795
- ***
2796
-
2797
- ### register()
2798
-
2799
- #### register(name, options)
2800
-
2801
- > `static` **register**(`name`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
2802
-
2803
- ##### Parameters
2804
-
2805
- • **name**: `string`
2806
-
2807
- • **options**: [`FuncItem`](../interfaces/FuncItem.md)
2808
-
2809
- ##### Returns
2810
-
2811
- `boolean` \| [`ToolFunc`](ToolFunc.md)
2812
-
2813
- ##### Inherited from
2814
-
2815
- [`ResClientTools`](ResClientTools.md).[`register`](ResClientTools.md#register-1)
2816
-
2817
- ##### Defined in
2818
-
2819
- [packages/ai-tool/src/tool-func.ts:172](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L172)
2820
-
2821
- #### register(func, options)
2822
-
2823
- > `static` **register**(`func`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
2824
-
2825
- ##### Parameters
2826
-
2827
- • **func**: `Function`
2828
-
2829
- • **options**: [`FuncItem`](../interfaces/FuncItem.md)
2830
-
2831
- ##### Returns
2832
-
2833
- `boolean` \| [`ToolFunc`](ToolFunc.md)
2834
-
2835
- ##### Inherited from
2836
-
2837
- [`ResClientTools`](ResClientTools.md).[`register`](ResClientTools.md#register-1)
2838
-
2839
- ##### Defined in
2840
-
2841
- [packages/ai-tool/src/tool-func.ts:173](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L173)
2842
-
2843
- #### register(name, options)
2844
-
2845
- > `static` **register**(`name`, `options`?): `boolean` \| [`ToolFunc`](ToolFunc.md)
2846
-
2847
- ##### Parameters
2848
-
2849
- • **name**: `string` \| `Function` \| [`ToolFunc`](ToolFunc.md) \| [`FuncItem`](../interfaces/FuncItem.md)
2850
-
2851
- • **options?**: [`FuncItem`](../interfaces/FuncItem.md)
2852
-
2853
- ##### Returns
2854
-
2855
- `boolean` \| [`ToolFunc`](ToolFunc.md)
2856
-
2857
- ##### Inherited from
2858
-
2859
- [`ResClientTools`](ResClientTools.md).[`register`](ResClientTools.md#register-1)
2860
-
2861
- ##### Defined in
2862
-
2863
- [packages/ai-tool/src/tool-func.ts:174](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L174)
2864
-
2865
- ***
2866
-
2867
- ### run()
2868
-
2869
- > `static` **run**(`name`, `params`?): `Promise`\<`any`\>
2870
-
2871
- #### Parameters
2872
-
2873
- • **name**: `string`
2874
-
2875
- • **params?**: `any`
2876
-
2877
- #### Returns
2878
-
2879
- `Promise`\<`any`\>
2880
-
2881
- #### Inherited from
2882
-
2883
- [`ResClientTools`](ResClientTools.md).[`run`](ResClientTools.md#run-1)
2884
-
2885
- #### Defined in
2886
-
2887
- [packages/ai-tool/src/tool-func.ts:130](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L130)
2888
-
2889
- ***
2890
-
2891
- ### runSync()
2892
-
2893
- > `static` **runSync**(`name`, `params`?): `any`
2894
-
2895
- #### Parameters
2896
-
2897
- • **name**: `string`
2898
-
2899
- • **params?**: `any`
2900
-
2901
- #### Returns
2902
-
2903
- `any`
2904
-
2905
- #### Inherited from
2906
-
2907
- [`ResClientTools`](ResClientTools.md).[`runSync`](ResClientTools.md#runsync-1)
2908
-
2909
- #### Defined in
2910
-
2911
- [packages/ai-tool/src/tool-func.ts:138](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L138)
2912
-
2913
- ***
2914
-
2915
- ### runWithPos()
2916
-
2917
- > `static` **runWithPos**(`name`, ...`params`): `Promise`\<`any`\>
2918
-
2919
- #### Parameters
2920
-
2921
- • **name**: `string`
2922
-
2923
- • ...**params**: `any`[]
2924
-
2925
- #### Returns
2926
-
2927
- `Promise`\<`any`\>
2928
-
2929
- #### Inherited from
2930
-
2931
- [`ResClientTools`](ResClientTools.md).[`runWithPos`](ResClientTools.md#runwithpos-1)
2932
-
2933
- #### Defined in
2934
-
2935
- [packages/ai-tool/src/tool-func.ts:151](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L151)
2936
-
2937
- ***
2938
-
2939
- ### runWithPosSync()
2940
-
2941
- > `static` **runWithPosSync**(`name`, ...`params`): `any`
2942
-
2943
- #### Parameters
2944
-
2945
- • **name**: `string`
2946
-
2947
- • ...**params**: `any`[]
2948
-
2949
- #### Returns
2950
-
2951
- `any`
2952
-
2953
- #### Inherited from
2954
-
2955
- [`ResClientTools`](ResClientTools.md).[`runWithPosSync`](ResClientTools.md#runwithpossync-1)
2956
-
2957
- #### Defined in
2958
-
2959
- [packages/ai-tool/src/tool-func.ts:159](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L159)
2960
-
2961
- ***
2962
-
2963
- ### seal()
2964
-
2965
- > `static` **seal**\<`T`\>(`o`): `T`
2966
-
2967
- Prevents the modification of attributes of existing properties, and prevents the addition of new properties.
2968
-
2969
- #### Type Parameters
2970
-
2971
- • **T**
2972
-
2973
- #### Parameters
2974
-
2975
- • **o**: `T`
2976
-
2977
- Object on which to lock the attributes.
2978
-
2979
- #### Returns
2980
-
2981
- `T`
2982
-
2983
- #### Inherited from
2984
-
2985
- [`ResClientTools`](ResClientTools.md).[`seal`](ResClientTools.md#seal)
2986
-
2987
- #### Defined in
2988
-
2989
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:216
2990
-
2991
- ***
2992
-
2993
- ### setApiRoot()
2994
-
2995
- > `static` **setApiRoot**(`v`): `void`
2996
-
2997
- #### Parameters
2998
-
2999
- • **v**: `string`
3000
-
3001
- #### Returns
3002
-
3003
- `void`
3004
-
3005
- #### Inherited from
3006
-
3007
- [`ResClientTools`](ResClientTools.md).[`setApiRoot`](ResClientTools.md#setapiroot)
3008
-
3009
- #### Defined in
3010
-
3011
- [packages/ai-tool/src/client-tools.ts:23](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/client-tools.ts#L23)
3012
-
3013
- ***
3014
-
3015
- ### setPrototypeOf()
3016
-
3017
- > `static` **setPrototypeOf**(`o`, `proto`): `any`
3018
-
3019
- Sets the prototype of a specified object o to object proto or null. Returns the object o.
3020
-
3021
- #### Parameters
3022
-
3023
- • **o**: `any`
3024
-
3025
- The object to change its prototype.
3026
-
3027
- • **proto**: `null` \| `object`
3028
-
3029
- The value of the new prototype or null.
3030
-
3031
- #### Returns
3032
-
3033
- `any`
3034
-
3035
- #### Inherited from
3036
-
3037
- [`ResClientTools`](ResClientTools.md).[`setPrototypeOf`](ResClientTools.md#setprototypeof)
3038
-
3039
- #### Defined in
3040
-
3041
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:339
3042
-
3043
- ***
3044
-
3045
- ### unregister()
3046
-
3047
- > `static` **unregister**(`name`): `undefined` \| [`ToolFunc`](ToolFunc.md)
3048
-
3049
- #### Parameters
3050
-
3051
- • **name**: `string`
3052
-
3053
- #### Returns
3054
-
3055
- `undefined` \| [`ToolFunc`](ToolFunc.md)
3056
-
3057
- #### Inherited from
3058
-
3059
- [`ResClientTools`](ResClientTools.md).[`unregister`](ResClientTools.md#unregister-1)
3060
-
3061
- #### Defined in
3062
-
3063
- [packages/ai-tool/src/tool-func.ts:202](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L202)
3064
-
3065
- ***
3066
-
3067
- ### values()
3068
-
3069
- #### values(o)
3070
-
3071
- > `static` **values**\<`T`\>(`o`): `T`[]
3072
-
3073
- Returns an array of values of the enumerable own properties of an object
3074
-
3075
- ##### Type Parameters
3076
-
3077
- • **T**
3078
-
3079
- ##### Parameters
3080
-
3081
- • **o**: `object` \| `ArrayLike`\<`T`\>
3082
-
3083
- Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.
3084
-
3085
- ##### Returns
3086
-
3087
- `T`[]
3088
-
3089
- ##### Inherited from
3090
-
3091
- [`ResClientTools`](ResClientTools.md).[`values`](ResClientTools.md#values)
3092
-
3093
- ##### Defined in
3094
-
3095
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es2017.object.d.ts:24
3096
-
3097
- #### values(o)
3098
-
3099
- > `static` **values**(`o`): `any`[]
3100
-
3101
- Returns an array of values of the enumerable own properties of an object
3102
-
3103
- ##### Parameters
3104
-
3105
- • **o**
3106
-
3107
- Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.
3108
-
3109
- ##### Returns
3110
-
3111
- `any`[]
3112
-
3113
- ##### Inherited from
3114
-
3115
- [`ResClientTools`](ResClientTools.md).[`values`](ResClientTools.md#values)
3116
-
3117
- ##### Defined in
3118
-
3119
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es2017.object.d.ts:30