@isdk/ai-tool 0.5.2 → 0.5.3

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