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