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