@isdk/ai-tool 0.3.0 → 0.5.0

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