@isdk/ai-tool 0.5.1 → 0.5.2

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