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