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