@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,2177 @@
1
+ [**@isdk/ai-tool**](../README.md)
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / ToolFunc
6
+
7
+ # Class: ToolFunc
8
+
9
+ Defined in: [packages/ai-tool/src/tool-func.ts:51](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L51)
10
+
11
+ ## Extends
12
+
13
+ - [`BaseFunc`](../interfaces/BaseFunc.md).`AdvancePropertyManager`
14
+
15
+ ## Extended by
16
+
17
+ - [`ClientTools`](ClientTools.md)
18
+ - [`ServerTools`](ServerTools.md)
19
+ - [`EventToolFunc`](EventToolFunc.md)
20
+
21
+ ## Indexable
22
+
23
+ \[`name`: `string`\]: `any`
24
+
25
+ ## Constructors
26
+
27
+ ### new ToolFunc()
28
+
29
+ > **new ToolFunc**(`name`, `options`): [`ToolFunc`](ToolFunc.md)
30
+
31
+ Defined in: [packages/ai-tool/src/tool-func.ts:192](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L192)
32
+
33
+ #### Parameters
34
+
35
+ ##### name
36
+
37
+ `string` | `Function` | [`FuncItem`](../interfaces/FuncItem.md)
38
+
39
+ ##### options
40
+
41
+ `any` = `{}`
42
+
43
+ #### Returns
44
+
45
+ [`ToolFunc`](ToolFunc.md)
46
+
47
+ #### Inherited from
48
+
49
+ `BaseFunc.constructor`
50
+
51
+ ## Properties
52
+
53
+ ### $attributes
54
+
55
+ > **$attributes**: `Properties`
56
+
57
+ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/advance.d.ts:5
58
+
59
+ ***
60
+
61
+ ### constructor
62
+
63
+ > **constructor**: `Function`
64
+
65
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:125
66
+
67
+ The initial value of Object.prototype.constructor is the standard built-in Object constructor.
68
+
69
+ ***
70
+
71
+ ### defaultOptions
72
+
73
+ > **defaultOptions**: `object`
74
+
75
+ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:74
76
+
77
+ The default options for export and assign
78
+
79
+ #### assign?
80
+
81
+ > `optional` **assign**: `IMergeOptions`
82
+
83
+ #### export?
84
+
85
+ > `optional` **export**: `IMergeOptions`
86
+
87
+ ***
88
+
89
+ ### isApi?
90
+
91
+ > `optional` **isApi**: `boolean`
92
+
93
+ Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L29)
94
+
95
+ #### Inherited from
96
+
97
+ [`BaseFunc`](../interfaces/BaseFunc.md).[`isApi`](../interfaces/BaseFunc.md#isapi)
98
+
99
+ ***
100
+
101
+ ### name?
102
+
103
+ > `optional` **name**: `string`
104
+
105
+ Defined in: [packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L23)
106
+
107
+ #### Inherited from
108
+
109
+ [`BaseFunc`](../interfaces/BaseFunc.md).[`name`](../interfaces/BaseFunc.md#name)
110
+
111
+ ***
112
+
113
+ ### nonExported1stChar
114
+
115
+ > **nonExported1stChar**: `string`
116
+
117
+ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:78
118
+
119
+ the property with the default prefix '$' will not be exported.
120
+
121
+ ***
122
+
123
+ ### params?
124
+
125
+ > `optional` **params**: [`FuncParams`](../interfaces/FuncParams.md) \| [`FuncParam`](../interfaces/FuncParam.md)[]
126
+
127
+ Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L24)
128
+
129
+ #### Inherited from
130
+
131
+ [`BaseFunc`](../interfaces/BaseFunc.md).[`params`](../interfaces/BaseFunc.md#params)
132
+
133
+ ***
134
+
135
+ ### result?
136
+
137
+ > `optional` **result**: `string`
138
+
139
+ Defined in: [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L25)
140
+
141
+ #### Inherited from
142
+
143
+ [`BaseFunc`](../interfaces/BaseFunc.md).[`result`](../interfaces/BaseFunc.md#result)
144
+
145
+ ***
146
+
147
+ ### scope?
148
+
149
+ > `optional` **scope**: `any`
150
+
151
+ Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L26)
152
+
153
+ #### Inherited from
154
+
155
+ [`BaseFunc`](../interfaces/BaseFunc.md).[`scope`](../interfaces/BaseFunc.md#scope)
156
+
157
+ ***
158
+
159
+ ### setup()?
160
+
161
+ > `optional` **setup**: (`this`, `options`?) => `void`
162
+
163
+ Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L28)
164
+
165
+ #### Parameters
166
+
167
+ ##### this
168
+
169
+ [`ToolFunc`](ToolFunc.md)
170
+
171
+ ##### options?
172
+
173
+ [`FuncItem`](../interfaces/FuncItem.md)
174
+
175
+ #### Returns
176
+
177
+ `void`
178
+
179
+ #### Inherited from
180
+
181
+ [`BaseFunc`](../interfaces/BaseFunc.md).[`setup`](../interfaces/BaseFunc.md#setup)
182
+
183
+ ***
184
+
185
+ ### stream?
186
+
187
+ > `optional` **stream**: `boolean`
188
+
189
+ Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L30)
190
+
191
+ #### Inherited from
192
+
193
+ [`BaseFunc`](../interfaces/BaseFunc.md).[`stream`](../interfaces/BaseFunc.md#stream)
194
+
195
+ ***
196
+
197
+ ### tags?
198
+
199
+ > `optional` **tags**: `string` \| `string`[]
200
+
201
+ Defined in: [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L27)
202
+
203
+ #### Inherited from
204
+
205
+ [`BaseFunc`](../interfaces/BaseFunc.md).[`tags`](../interfaces/BaseFunc.md#tags)
206
+
207
+ ***
208
+
209
+ ### dataPath
210
+
211
+ > `static` **dataPath**: `string`
212
+
213
+ Defined in: [packages/ai-tool/src/tool-func.ts:57](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L57)
214
+
215
+ ***
216
+
217
+ ### items
218
+
219
+ > `static` **items**: [`Funcs`](../interfaces/Funcs.md) = `{}`
220
+
221
+ Defined in: [packages/ai-tool/src/tool-func.ts:56](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L56)
222
+
223
+ ## Methods
224
+
225
+ ### arr2ObjParams()
226
+
227
+ > **arr2ObjParams**(`params`): `any`[]
228
+
229
+ Defined in: [packages/ai-tool/src/tool-func.ts:236](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L236)
230
+
231
+ #### Parameters
232
+
233
+ ##### params
234
+
235
+ `any`[]
236
+
237
+ #### Returns
238
+
239
+ `any`[]
240
+
241
+ ***
242
+
243
+ ### assign()
244
+
245
+ > **assign**(`src`, `options`?): `this`
246
+
247
+ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:106
248
+
249
+ Assign the values from the src object.
250
+
251
+ #### Parameters
252
+
253
+ ##### src
254
+
255
+ `any`
256
+
257
+ the source object
258
+
259
+ ##### options?
260
+
261
+ `IMergeOptions`
262
+
263
+ #### Returns
264
+
265
+ `this`
266
+
267
+ this object
268
+
269
+ ***
270
+
271
+ ### assignProperty()
272
+
273
+ > **assignProperty**(`src`, `name`, `value`, `attrs`?, `options`?): `void`
274
+
275
+ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:117
276
+
277
+ Assign a property of src to this object.
278
+
279
+ #### Parameters
280
+
281
+ ##### src
282
+
283
+ `any`
284
+
285
+ the src object
286
+
287
+ ##### name
288
+
289
+ `string`
290
+
291
+ the property name to assign
292
+
293
+ ##### value
294
+
295
+ `any`
296
+
297
+ the property value to assign
298
+
299
+ ##### attrs?
300
+
301
+ `any`
302
+
303
+ the attributes object
304
+
305
+ ##### options?
306
+
307
+ `IMergeOptions`
308
+
309
+ #### Returns
310
+
311
+ `void`
312
+
313
+ ***
314
+
315
+ ### assignPropertyTo()
316
+
317
+ > `abstract` **assignPropertyTo**(`dest`, `src`, `name`, `value`, `attrs`?, `options`?): `void`
318
+
319
+ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:131
320
+
321
+ Assign the property value from the src to destination object.
322
+
323
+ #### Parameters
324
+
325
+ ##### dest
326
+
327
+ `any`
328
+
329
+ The destination object
330
+
331
+ ##### src
332
+
333
+ `any`
334
+
335
+ The src object
336
+
337
+ ##### name
338
+
339
+ `string`
340
+
341
+ The property name
342
+
343
+ ##### value
344
+
345
+ `any`
346
+
347
+ The property value
348
+
349
+ ##### attrs?
350
+
351
+ `any`
352
+
353
+ The attributes object of the property
354
+
355
+ ##### options?
356
+
357
+ `IMergeOptions`
358
+
359
+ #### Returns
360
+
361
+ `void`
362
+
363
+ ***
364
+
365
+ ### assignTo()
366
+
367
+ > **assignTo**(`dest`?, `options`?): `any`
368
+
369
+ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:191
370
+
371
+ Assign this attributes to the dest object
372
+
373
+ #### Parameters
374
+
375
+ ##### dest?
376
+
377
+ `any`
378
+
379
+ the destination object
380
+
381
+ ##### options?
382
+
383
+ `IMergeOptions`
384
+
385
+ #### Returns
386
+
387
+ `any`
388
+
389
+ the dest object
390
+
391
+ ***
392
+
393
+ ### clone()
394
+
395
+ > **clone**(`options`?): `any`
396
+
397
+ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:155
398
+
399
+ Create a new object with the same values of attributes.
400
+
401
+ #### Parameters
402
+
403
+ ##### options?
404
+
405
+ `IMergeOptions`
406
+
407
+ #### Returns
408
+
409
+ `any`
410
+
411
+ the new object
412
+
413
+ ***
414
+
415
+ ### cloneTo()
416
+
417
+ > **cloneTo**(`dest`, `options`?): `any`
418
+
419
+ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:148
420
+
421
+ Create and assign the values to the destination object.
422
+
423
+ #### Parameters
424
+
425
+ ##### dest
426
+
427
+ `any`
428
+
429
+ the destination object
430
+
431
+ ##### options?
432
+
433
+ `IMergeOptions`
434
+
435
+ #### Returns
436
+
437
+ `any`
438
+
439
+ the new dest object
440
+
441
+ ***
442
+
443
+ ### defineProperties()
444
+
445
+ > `abstract` **defineProperties**(`aProperties`): `any`
446
+
447
+ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:89
448
+
449
+ Define the attributes of this object.
450
+
451
+ #### Parameters
452
+
453
+ ##### aProperties
454
+
455
+ `SimplePropDescriptors`
456
+
457
+ the defined attributes of the object
458
+
459
+ #### Returns
460
+
461
+ `any`
462
+
463
+ ***
464
+
465
+ ### exportTo()
466
+
467
+ > **exportTo**(`dest`, `options`?): `any`
468
+
469
+ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:173
470
+
471
+ Export attributes to the dest json object.
472
+
473
+ #### Parameters
474
+
475
+ ##### dest
476
+
477
+ `any`
478
+
479
+ the destination object
480
+
481
+ ##### options?
482
+
483
+ `IExportOptions`
484
+
485
+ #### Returns
486
+
487
+ `any`
488
+
489
+ the dest object.
490
+
491
+ ***
492
+
493
+ ### func()
494
+
495
+ > **func**(...`params`): `any`
496
+
497
+ Defined in: [packages/ai-tool/src/tool-func.ts:38](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L38)
498
+
499
+ #### Parameters
500
+
501
+ ##### params
502
+
503
+ ...`any`
504
+
505
+ #### Returns
506
+
507
+ `any`
508
+
509
+ #### Inherited from
510
+
511
+ [`BaseFunc`](../interfaces/BaseFunc.md).[`func`](../interfaces/BaseFunc.md#func)
512
+
513
+ ***
514
+
515
+ ### getFunc()
516
+
517
+ > **getFunc**(`name`?): `any`
518
+
519
+ Defined in: [packages/ai-tool/src/tool-func.ts:289](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L289)
520
+
521
+ #### Parameters
522
+
523
+ ##### name?
524
+
525
+ `string`
526
+
527
+ #### Returns
528
+
529
+ `any`
530
+
531
+ ***
532
+
533
+ ### getFuncWithPos()
534
+
535
+ > **getFuncWithPos**(`name`?): `any`
536
+
537
+ Defined in: [packages/ai-tool/src/tool-func.ts:313](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L313)
538
+
539
+ #### Parameters
540
+
541
+ ##### name?
542
+
543
+ `string`
544
+
545
+ #### Returns
546
+
547
+ `any`
548
+
549
+ ***
550
+
551
+ ### getProperties()
552
+
553
+ > `abstract` **getProperties**(): `PropDescriptors`
554
+
555
+ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:98
556
+
557
+ Get the defined attributes.
558
+
559
+ #### Returns
560
+
561
+ `PropDescriptors`
562
+
563
+ the descriptors of properties object
564
+
565
+ ***
566
+
567
+ ### hasAsyncFeature()
568
+
569
+ > **hasAsyncFeature**(`feature`): `boolean`
570
+
571
+ Defined in: [packages/ai-tool/src/tool-func.ts:318](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L318)
572
+
573
+ #### Parameters
574
+
575
+ ##### feature
576
+
577
+ [`AsyncFeatureBits`](../enumerations/AsyncFeatureBits.md)
578
+
579
+ #### Returns
580
+
581
+ `boolean`
582
+
583
+ ***
584
+
585
+ ### hasOwnProperty()
586
+
587
+ > **hasOwnProperty**(`v`): `boolean`
588
+
589
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:140
590
+
591
+ Determines whether an object has a property with the specified name.
592
+
593
+ #### Parameters
594
+
595
+ ##### v
596
+
597
+ `PropertyKey`
598
+
599
+ A property name.
600
+
601
+ #### Returns
602
+
603
+ `boolean`
604
+
605
+ ***
606
+
607
+ ### initialize()
608
+
609
+ > **initialize**(`src`?): `this`
610
+
611
+ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:139
612
+
613
+ Initialize object and assign attribute values from src if src exists.
614
+
615
+ #### Parameters
616
+
617
+ ##### src?
618
+
619
+ `any`
620
+
621
+ #### Returns
622
+
623
+ `this`
624
+
625
+ this object.
626
+
627
+ ***
628
+
629
+ ### isPrototypeOf()
630
+
631
+ > **isPrototypeOf**(`v`): `boolean`
632
+
633
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:146
634
+
635
+ Determines whether an object exists in another object's prototype chain.
636
+
637
+ #### Parameters
638
+
639
+ ##### v
640
+
641
+ `Object`
642
+
643
+ Another object whose prototype chain is to be checked.
644
+
645
+ #### Returns
646
+
647
+ `boolean`
648
+
649
+ ***
650
+
651
+ ### isSame()
652
+
653
+ > **isSame**(`src`, `options`?): `boolean`
654
+
655
+ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:200
656
+
657
+ Check the src object whether “equals” this object.
658
+
659
+ #### Parameters
660
+
661
+ ##### src
662
+
663
+ `any`
664
+
665
+ The source object
666
+
667
+ ##### options?
668
+
669
+ `IMergeOptions`
670
+
671
+ #### Returns
672
+
673
+ `boolean`
674
+
675
+ ***
676
+
677
+ ### isStream()
678
+
679
+ > **isStream**(`params`): `undefined` \| `boolean`
680
+
681
+ Defined in: [packages/ai-tool/src/tool-func.ts:324](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L324)
682
+
683
+ #### Parameters
684
+
685
+ ##### params
686
+
687
+ `any`
688
+
689
+ #### Returns
690
+
691
+ `undefined` \| `boolean`
692
+
693
+ ***
694
+
695
+ ### mergeTo()
696
+
697
+ > **mergeTo**(`dest`, `options`?): `any`
698
+
699
+ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:164
700
+
701
+ Merge this attributes to dest object.
702
+
703
+ #### Parameters
704
+
705
+ ##### dest
706
+
707
+ `any`
708
+
709
+ The destination object
710
+
711
+ ##### options?
712
+
713
+ `IMergeOptions`
714
+
715
+ #### Returns
716
+
717
+ `any`
718
+
719
+ the dest object.
720
+
721
+ ***
722
+
723
+ ### obj2ArrParams()
724
+
725
+ > **obj2ArrParams**(`params`?): `any`[]
726
+
727
+ Defined in: [packages/ai-tool/src/tool-func.ts:249](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L249)
728
+
729
+ #### Parameters
730
+
731
+ ##### params?
732
+
733
+ `any`
734
+
735
+ #### Returns
736
+
737
+ `any`[]
738
+
739
+ ***
740
+
741
+ ### propertyIsEnumerable()
742
+
743
+ > **propertyIsEnumerable**(`v`): `boolean`
744
+
745
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:152
746
+
747
+ Determines whether a specified property is enumerable.
748
+
749
+ #### Parameters
750
+
751
+ ##### v
752
+
753
+ `PropertyKey`
754
+
755
+ A property name.
756
+
757
+ #### Returns
758
+
759
+ `boolean`
760
+
761
+ ***
762
+
763
+ ### register()
764
+
765
+ > **register**(): `boolean` \| [`ToolFunc`](ToolFunc.md)
766
+
767
+ Defined in: [packages/ai-tool/src/tool-func.ts:219](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L219)
768
+
769
+ #### Returns
770
+
771
+ `boolean` \| [`ToolFunc`](ToolFunc.md)
772
+
773
+ ***
774
+
775
+ ### run()
776
+
777
+ > **run**(`params`?): `Promise`\<`any`\>
778
+
779
+ Defined in: [packages/ai-tool/src/tool-func.ts:276](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L276)
780
+
781
+ #### Parameters
782
+
783
+ ##### params?
784
+
785
+ `any`
786
+
787
+ #### Returns
788
+
789
+ `Promise`\<`any`\>
790
+
791
+ ***
792
+
793
+ ### runAs()
794
+
795
+ > **runAs**(`name`, `params`?): `Promise`\<`any`\>
796
+
797
+ Defined in: [packages/ai-tool/src/tool-func.ts:280](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L280)
798
+
799
+ #### Parameters
800
+
801
+ ##### name
802
+
803
+ `string`
804
+
805
+ ##### params?
806
+
807
+ `any`
808
+
809
+ #### Returns
810
+
811
+ `Promise`\<`any`\>
812
+
813
+ ***
814
+
815
+ ### runAsSync()
816
+
817
+ > **runAsSync**(`name`, `params`?): `any`
818
+
819
+ Defined in: [packages/ai-tool/src/tool-func.ts:284](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L284)
820
+
821
+ #### Parameters
822
+
823
+ ##### name
824
+
825
+ `string`
826
+
827
+ ##### params?
828
+
829
+ `any`
830
+
831
+ #### Returns
832
+
833
+ `any`
834
+
835
+ ***
836
+
837
+ ### runSync()
838
+
839
+ > **runSync**(`params`?): `any`
840
+
841
+ Defined in: [packages/ai-tool/src/tool-func.ts:262](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L262)
842
+
843
+ #### Parameters
844
+
845
+ ##### params?
846
+
847
+ `any`
848
+
849
+ #### Returns
850
+
851
+ `any`
852
+
853
+ ***
854
+
855
+ ### runWithPos()
856
+
857
+ > **runWithPos**(...`params`): `Promise`\<`any`\>
858
+
859
+ Defined in: [packages/ai-tool/src/tool-func.ts:305](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L305)
860
+
861
+ #### Parameters
862
+
863
+ ##### params
864
+
865
+ ...`any`[]
866
+
867
+ #### Returns
868
+
869
+ `Promise`\<`any`\>
870
+
871
+ ***
872
+
873
+ ### runWithPosAs()
874
+
875
+ > **runWithPosAs**(`name`, ...`params`): `Promise`\<`any`\>
876
+
877
+ Defined in: [packages/ai-tool/src/tool-func.ts:309](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L309)
878
+
879
+ #### Parameters
880
+
881
+ ##### name
882
+
883
+ `string`
884
+
885
+ ##### params
886
+
887
+ ...`any`[]
888
+
889
+ #### Returns
890
+
891
+ `Promise`\<`any`\>
892
+
893
+ ***
894
+
895
+ ### runWithPosAsSync()
896
+
897
+ > **runWithPosAsSync**(`name`, ...`params`): `any`
898
+
899
+ Defined in: [packages/ai-tool/src/tool-func.ts:301](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L301)
900
+
901
+ #### Parameters
902
+
903
+ ##### name
904
+
905
+ `string`
906
+
907
+ ##### params
908
+
909
+ ...`any`[]
910
+
911
+ #### Returns
912
+
913
+ `any`
914
+
915
+ ***
916
+
917
+ ### runWithPosSync()
918
+
919
+ > **runWithPosSync**(...`params`): `any`
920
+
921
+ Defined in: [packages/ai-tool/src/tool-func.ts:294](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L294)
922
+
923
+ #### Parameters
924
+
925
+ ##### params
926
+
927
+ ...`any`[]
928
+
929
+ #### Returns
930
+
931
+ `any`
932
+
933
+ ***
934
+
935
+ ### toJSON()
936
+
937
+ > **toJSON**(): `any`
938
+
939
+ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:182
940
+
941
+ #### Returns
942
+
943
+ `any`
944
+
945
+ ***
946
+
947
+ ### toLocaleString()
948
+
949
+ > **toLocaleString**(): `string`
950
+
951
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:131
952
+
953
+ Returns a date converted to a string using the current locale.
954
+
955
+ #### Returns
956
+
957
+ `string`
958
+
959
+ ***
960
+
961
+ ### toObject()
962
+
963
+ > **toObject**(`options`?): `any`
964
+
965
+ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/abstract.d.ts:181
966
+
967
+ Convert the attributes to the json object
968
+
969
+ #### Parameters
970
+
971
+ ##### options?
972
+
973
+ `any`
974
+
975
+ #### Returns
976
+
977
+ `any`
978
+
979
+ the json object.
980
+
981
+ ***
982
+
983
+ ### toString()
984
+
985
+ > **toString**(): `string`
986
+
987
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:128
988
+
989
+ Returns a string representation of an object.
990
+
991
+ #### Returns
992
+
993
+ `string`
994
+
995
+ ***
996
+
997
+ ### unregister()
998
+
999
+ > **unregister**(): `any`
1000
+
1001
+ Defined in: [packages/ai-tool/src/tool-func.ts:232](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L232)
1002
+
1003
+ #### Returns
1004
+
1005
+ `any`
1006
+
1007
+ ***
1008
+
1009
+ ### valueOf()
1010
+
1011
+ > **valueOf**(): `Object`
1012
+
1013
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:134
1014
+
1015
+ Returns the primitive value of the specified object.
1016
+
1017
+ #### Returns
1018
+
1019
+ `Object`
1020
+
1021
+ ***
1022
+
1023
+ ### assign()
1024
+
1025
+ #### Call Signature
1026
+
1027
+ > `static` **assign**\<`T`, `U`\>(`target`, `source`): `T` & `U`
1028
+
1029
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:286
1030
+
1031
+ Copy the values of all of the enumerable own properties from one or more source objects to a
1032
+ target object. Returns the target object.
1033
+
1034
+ ##### Type Parameters
1035
+
1036
+ • **T** *extends* `object`
1037
+
1038
+ • **U**
1039
+
1040
+ ##### Parameters
1041
+
1042
+ ###### target
1043
+
1044
+ `T`
1045
+
1046
+ The target object to copy to.
1047
+
1048
+ ###### source
1049
+
1050
+ `U`
1051
+
1052
+ The source object from which to copy properties.
1053
+
1054
+ ##### Returns
1055
+
1056
+ `T` & `U`
1057
+
1058
+ #### Call Signature
1059
+
1060
+ > `static` **assign**\<`T`, `U`, `V`\>(`target`, `source1`, `source2`): `T` & `U` & `V`
1061
+
1062
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:295
1063
+
1064
+ Copy the values of all of the enumerable own properties from one or more source objects to a
1065
+ target object. Returns the target object.
1066
+
1067
+ ##### Type Parameters
1068
+
1069
+ • **T** *extends* `object`
1070
+
1071
+ • **U**
1072
+
1073
+ • **V**
1074
+
1075
+ ##### Parameters
1076
+
1077
+ ###### target
1078
+
1079
+ `T`
1080
+
1081
+ The target object to copy to.
1082
+
1083
+ ###### source1
1084
+
1085
+ `U`
1086
+
1087
+ The first source object from which to copy properties.
1088
+
1089
+ ###### source2
1090
+
1091
+ `V`
1092
+
1093
+ The second source object from which to copy properties.
1094
+
1095
+ ##### Returns
1096
+
1097
+ `T` & `U` & `V`
1098
+
1099
+ #### Call Signature
1100
+
1101
+ > `static` **assign**\<`T`, `U`, `V`, `W`\>(`target`, `source1`, `source2`, `source3`): `T` & `U` & `V` & `W`
1102
+
1103
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:305
1104
+
1105
+ Copy the values of all of the enumerable own properties from one or more source objects to a
1106
+ target object. Returns the target object.
1107
+
1108
+ ##### Type Parameters
1109
+
1110
+ • **T** *extends* `object`
1111
+
1112
+ • **U**
1113
+
1114
+ • **V**
1115
+
1116
+ • **W**
1117
+
1118
+ ##### Parameters
1119
+
1120
+ ###### target
1121
+
1122
+ `T`
1123
+
1124
+ The target object to copy to.
1125
+
1126
+ ###### source1
1127
+
1128
+ `U`
1129
+
1130
+ The first source object from which to copy properties.
1131
+
1132
+ ###### source2
1133
+
1134
+ `V`
1135
+
1136
+ The second source object from which to copy properties.
1137
+
1138
+ ###### source3
1139
+
1140
+ `W`
1141
+
1142
+ The third source object from which to copy properties.
1143
+
1144
+ ##### Returns
1145
+
1146
+ `T` & `U` & `V` & `W`
1147
+
1148
+ #### Call Signature
1149
+
1150
+ > `static` **assign**(`target`, ...`sources`): `any`
1151
+
1152
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:313
1153
+
1154
+ Copy the values of all of the enumerable own properties from one or more source objects to a
1155
+ target object. Returns the target object.
1156
+
1157
+ ##### Parameters
1158
+
1159
+ ###### target
1160
+
1161
+ `object`
1162
+
1163
+ The target object to copy to.
1164
+
1165
+ ###### sources
1166
+
1167
+ ...`any`[]
1168
+
1169
+ One or more source objects from which to copy properties
1170
+
1171
+ ##### Returns
1172
+
1173
+ `any`
1174
+
1175
+ ***
1176
+
1177
+ ### create()
1178
+
1179
+ #### Call Signature
1180
+
1181
+ > `static` **create**(`o`): `any`
1182
+
1183
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:188
1184
+
1185
+ Creates an object that has the specified prototype or that has null prototype.
1186
+
1187
+ ##### Parameters
1188
+
1189
+ ###### o
1190
+
1191
+ Object to use as a prototype. May be null.
1192
+
1193
+ `null` | `object`
1194
+
1195
+ ##### Returns
1196
+
1197
+ `any`
1198
+
1199
+ #### Call Signature
1200
+
1201
+ > `static` **create**(`o`, `properties`): `any`
1202
+
1203
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:195
1204
+
1205
+ Creates an object that has the specified prototype, and that optionally contains specified properties.
1206
+
1207
+ ##### Parameters
1208
+
1209
+ ###### o
1210
+
1211
+ Object to use as a prototype. May be null
1212
+
1213
+ `null` | `object`
1214
+
1215
+ ###### properties
1216
+
1217
+ `PropertyDescriptorMap` & `ThisType`\<`any`\>
1218
+
1219
+ JavaScript object that contains one or more property descriptors.
1220
+
1221
+ ##### Returns
1222
+
1223
+ `any`
1224
+
1225
+ ***
1226
+
1227
+ ### defineProperties()
1228
+
1229
+ > `static` **defineProperties**(`aTarget`, `aProperties`, `recreate`?): `any`
1230
+
1231
+ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/advance.d.ts:11
1232
+
1233
+ Adds one or more properties to an object, and/or modifies attributes of existing properties.
1234
+
1235
+ #### Parameters
1236
+
1237
+ ##### aTarget
1238
+
1239
+ `any`
1240
+
1241
+ ##### aProperties
1242
+
1243
+ `PropDescriptors`
1244
+
1245
+ ##### recreate?
1246
+
1247
+ `boolean`
1248
+
1249
+ #### Returns
1250
+
1251
+ `any`
1252
+
1253
+ ***
1254
+
1255
+ ### defineProperty()
1256
+
1257
+ > `static` **defineProperty**\<`T`\>(`o`, `p`, `attributes`): `T`
1258
+
1259
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:203
1260
+
1261
+ Adds a property to an object, or modifies attributes of an existing property.
1262
+
1263
+ #### Type Parameters
1264
+
1265
+ • **T**
1266
+
1267
+ #### Parameters
1268
+
1269
+ ##### o
1270
+
1271
+ `T`
1272
+
1273
+ 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.
1274
+
1275
+ ##### p
1276
+
1277
+ `PropertyKey`
1278
+
1279
+ The property name.
1280
+
1281
+ ##### attributes
1282
+
1283
+ `PropertyDescriptor` & `ThisType`\<`any`\>
1284
+
1285
+ Descriptor for the property. It can be for a data property or an accessor property.
1286
+
1287
+ #### Returns
1288
+
1289
+ `T`
1290
+
1291
+ ***
1292
+
1293
+ ### entries()
1294
+
1295
+ #### Call Signature
1296
+
1297
+ > `static` **entries**\<`T`\>(`o`): \[`string`, `T`\][]
1298
+
1299
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2017.object.d.ts:36
1300
+
1301
+ Returns an array of key/values of the enumerable own properties of an object
1302
+
1303
+ ##### Type Parameters
1304
+
1305
+ • **T**
1306
+
1307
+ ##### Parameters
1308
+
1309
+ ###### o
1310
+
1311
+ Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.
1312
+
1313
+ \{\} | `ArrayLike`\<`T`\>
1314
+
1315
+ ##### Returns
1316
+
1317
+ \[`string`, `T`\][]
1318
+
1319
+ #### Call Signature
1320
+
1321
+ > `static` **entries**(`o`): \[`string`, `any`\][]
1322
+
1323
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2017.object.d.ts:42
1324
+
1325
+ Returns an array of key/values of the enumerable own properties of an object
1326
+
1327
+ ##### Parameters
1328
+
1329
+ ###### o
1330
+
1331
+ Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.
1332
+
1333
+ ##### Returns
1334
+
1335
+ \[`string`, `any`\][]
1336
+
1337
+ ***
1338
+
1339
+ ### freeze()
1340
+
1341
+ #### Call Signature
1342
+
1343
+ > `static` **freeze**\<`T`\>(`f`): `T`
1344
+
1345
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:222
1346
+
1347
+ Prevents the modification of existing property attributes and values, and prevents the addition of new properties.
1348
+
1349
+ ##### Type Parameters
1350
+
1351
+ • **T** *extends* `Function`
1352
+
1353
+ ##### Parameters
1354
+
1355
+ ###### f
1356
+
1357
+ `T`
1358
+
1359
+ Object on which to lock the attributes.
1360
+
1361
+ ##### Returns
1362
+
1363
+ `T`
1364
+
1365
+ #### Call Signature
1366
+
1367
+ > `static` **freeze**\<`T`, `U`\>(`o`): `Readonly`\<`T`\>
1368
+
1369
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:228
1370
+
1371
+ Prevents the modification of existing property attributes and values, and prevents the addition of new properties.
1372
+
1373
+ ##### Type Parameters
1374
+
1375
+ • **T** *extends* `object`
1376
+
1377
+ • **U** *extends* `string` \| `number` \| `bigint` \| `boolean` \| `symbol`
1378
+
1379
+ ##### Parameters
1380
+
1381
+ ###### o
1382
+
1383
+ `T`
1384
+
1385
+ Object on which to lock the attributes.
1386
+
1387
+ ##### Returns
1388
+
1389
+ `Readonly`\<`T`\>
1390
+
1391
+ #### Call Signature
1392
+
1393
+ > `static` **freeze**\<`T`\>(`o`): `Readonly`\<`T`\>
1394
+
1395
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:234
1396
+
1397
+ Prevents the modification of existing property attributes and values, and prevents the addition of new properties.
1398
+
1399
+ ##### Type Parameters
1400
+
1401
+ • **T**
1402
+
1403
+ ##### Parameters
1404
+
1405
+ ###### o
1406
+
1407
+ `T`
1408
+
1409
+ Object on which to lock the attributes.
1410
+
1411
+ ##### Returns
1412
+
1413
+ `Readonly`\<`T`\>
1414
+
1415
+ ***
1416
+
1417
+ ### fromEntries()
1418
+
1419
+ #### Call Signature
1420
+
1421
+ > `static` **fromEntries**\<`T`\>(`entries`): `object`
1422
+
1423
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2019.object.d.ts:26
1424
+
1425
+ Returns an object created by key-value entries for properties and methods
1426
+
1427
+ ##### Type Parameters
1428
+
1429
+ • **T** = `any`
1430
+
1431
+ ##### Parameters
1432
+
1433
+ ###### entries
1434
+
1435
+ `Iterable`\<readonly \[`PropertyKey`, `T`\]\>
1436
+
1437
+ An iterable object that contains key-value entries for properties and methods.
1438
+
1439
+ ##### Returns
1440
+
1441
+ `object`
1442
+
1443
+ #### Call Signature
1444
+
1445
+ > `static` **fromEntries**(`entries`): `any`
1446
+
1447
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2019.object.d.ts:32
1448
+
1449
+ Returns an object created by key-value entries for properties and methods
1450
+
1451
+ ##### Parameters
1452
+
1453
+ ###### entries
1454
+
1455
+ `Iterable`\<readonly `any`[]\>
1456
+
1457
+ An iterable object that contains key-value entries for properties and methods.
1458
+
1459
+ ##### Returns
1460
+
1461
+ `any`
1462
+
1463
+ ***
1464
+
1465
+ ### get()
1466
+
1467
+ > `static` **get**(`name`): [`ToolFunc`](ToolFunc.md)
1468
+
1469
+ Defined in: [packages/ai-tool/src/tool-func.ts:59](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L59)
1470
+
1471
+ #### Parameters
1472
+
1473
+ ##### name
1474
+
1475
+ `string`
1476
+
1477
+ #### Returns
1478
+
1479
+ [`ToolFunc`](ToolFunc.md)
1480
+
1481
+ ***
1482
+
1483
+ ### getAllByTag()
1484
+
1485
+ > `static` **getAllByTag**(`tagName`): [`ToolFunc`](ToolFunc.md)[]
1486
+
1487
+ Defined in: [packages/ai-tool/src/tool-func.ts:87](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L87)
1488
+
1489
+ #### Parameters
1490
+
1491
+ ##### tagName
1492
+
1493
+ `string`
1494
+
1495
+ #### Returns
1496
+
1497
+ [`ToolFunc`](ToolFunc.md)[]
1498
+
1499
+ ***
1500
+
1501
+ ### getByTag()
1502
+
1503
+ > `static` **getByTag**(`tagName`): `undefined` \| [`ToolFunc`](ToolFunc.md)
1504
+
1505
+ Defined in: [packages/ai-tool/src/tool-func.ts:67](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L67)
1506
+
1507
+ #### Parameters
1508
+
1509
+ ##### tagName
1510
+
1511
+ `string`
1512
+
1513
+ #### Returns
1514
+
1515
+ `undefined` \| [`ToolFunc`](ToolFunc.md)
1516
+
1517
+ ***
1518
+
1519
+ ### getFunc()
1520
+
1521
+ > `static` **getFunc**(`name`): `any`
1522
+
1523
+ Defined in: [packages/ai-tool/src/tool-func.ts:128](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L128)
1524
+
1525
+ #### Parameters
1526
+
1527
+ ##### name
1528
+
1529
+ `string`
1530
+
1531
+ #### Returns
1532
+
1533
+ `any`
1534
+
1535
+ ***
1536
+
1537
+ ### getFuncWithPos()
1538
+
1539
+ > `static` **getFuncWithPos**(`name`): `any`
1540
+
1541
+ Defined in: [packages/ai-tool/src/tool-func.ts:149](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L149)
1542
+
1543
+ #### Parameters
1544
+
1545
+ ##### name
1546
+
1547
+ `string`
1548
+
1549
+ #### Returns
1550
+
1551
+ `any`
1552
+
1553
+ ***
1554
+
1555
+ ### getOwnPropertyDescriptor()
1556
+
1557
+ > `static` **getOwnPropertyDescriptor**(`o`, `p`): `undefined` \| `PropertyDescriptor`
1558
+
1559
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:175
1560
+
1561
+ Gets the own property descriptor of the specified object.
1562
+ An own property descriptor is one that is defined directly on the object and is not inherited from the object's prototype.
1563
+
1564
+ #### Parameters
1565
+
1566
+ ##### o
1567
+
1568
+ `any`
1569
+
1570
+ Object that contains the property.
1571
+
1572
+ ##### p
1573
+
1574
+ `PropertyKey`
1575
+
1576
+ Name of the property.
1577
+
1578
+ #### Returns
1579
+
1580
+ `undefined` \| `PropertyDescriptor`
1581
+
1582
+ ***
1583
+
1584
+ ### getOwnPropertyDescriptors()
1585
+
1586
+ > `static` **getOwnPropertyDescriptors**\<`T`\>(`o`): \{ \[P in string \| number \| symbol\]: TypedPropertyDescriptor\<T\[P\]\> \} & `object`
1587
+
1588
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2017.object.d.ts:48
1589
+
1590
+ Returns an object containing all own property descriptors of an object
1591
+
1592
+ #### Type Parameters
1593
+
1594
+ • **T**
1595
+
1596
+ #### Parameters
1597
+
1598
+ ##### o
1599
+
1600
+ `T`
1601
+
1602
+ Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.
1603
+
1604
+ #### Returns
1605
+
1606
+ \{ \[P in string \| number \| symbol\]: TypedPropertyDescriptor\<T\[P\]\> \} & `object`
1607
+
1608
+ ***
1609
+
1610
+ ### getOwnPropertyNames()
1611
+
1612
+ > `static` **getOwnPropertyNames**(`o`): `string`[]
1613
+
1614
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:182
1615
+
1616
+ Returns the names of the own properties of an object. The own properties of an object are those that are defined directly
1617
+ on that object, and are not inherited from the object's prototype. The properties of an object include both fields (objects) and functions.
1618
+
1619
+ #### Parameters
1620
+
1621
+ ##### o
1622
+
1623
+ `any`
1624
+
1625
+ Object that contains the own properties.
1626
+
1627
+ #### Returns
1628
+
1629
+ `string`[]
1630
+
1631
+ ***
1632
+
1633
+ ### getOwnPropertySymbols()
1634
+
1635
+ > `static` **getOwnPropertySymbols**(`o`): `symbol`[]
1636
+
1637
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:319
1638
+
1639
+ Returns an array of all symbol properties found directly on object o.
1640
+
1641
+ #### Parameters
1642
+
1643
+ ##### o
1644
+
1645
+ `any`
1646
+
1647
+ Object to retrieve the symbols from.
1648
+
1649
+ #### Returns
1650
+
1651
+ `symbol`[]
1652
+
1653
+ ***
1654
+
1655
+ ### getProperties()
1656
+
1657
+ > `static` **getProperties**(): `PropDescriptors`
1658
+
1659
+ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-manager/lib/advance.d.ts:10
1660
+
1661
+ get all properties descriptor include inherited.
1662
+
1663
+ #### Returns
1664
+
1665
+ `PropDescriptors`
1666
+
1667
+ ***
1668
+
1669
+ ### getPrototypeOf()
1670
+
1671
+ > `static` **getPrototypeOf**(`o`): `any`
1672
+
1673
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:167
1674
+
1675
+ Returns the prototype of an object.
1676
+
1677
+ #### Parameters
1678
+
1679
+ ##### o
1680
+
1681
+ `any`
1682
+
1683
+ The object that references the prototype.
1684
+
1685
+ #### Returns
1686
+
1687
+ `any`
1688
+
1689
+ ***
1690
+
1691
+ ### hasAsyncFeature()
1692
+
1693
+ > `static` **hasAsyncFeature**(`feature`): `boolean`
1694
+
1695
+ Defined in: [packages/ai-tool/src/tool-func.ts:105](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L105)
1696
+
1697
+ #### Parameters
1698
+
1699
+ ##### feature
1700
+
1701
+ [`AsyncFeatureBits`](../enumerations/AsyncFeatureBits.md)
1702
+
1703
+ #### Returns
1704
+
1705
+ `boolean`
1706
+
1707
+ ***
1708
+
1709
+ ### hasOwn()
1710
+
1711
+ > `static` **hasOwn**(`o`, `v`): `boolean`
1712
+
1713
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2022.object.d.ts:25
1714
+
1715
+ Determines whether an object has a property with the specified name.
1716
+
1717
+ #### Parameters
1718
+
1719
+ ##### o
1720
+
1721
+ `object`
1722
+
1723
+ An object.
1724
+
1725
+ ##### v
1726
+
1727
+ `PropertyKey`
1728
+
1729
+ A property name.
1730
+
1731
+ #### Returns
1732
+
1733
+ `boolean`
1734
+
1735
+ ***
1736
+
1737
+ ### is()
1738
+
1739
+ > `static` **is**(`value1`, `value2`): `boolean`
1740
+
1741
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:332
1742
+
1743
+ Returns true if the values are the same value, false otherwise.
1744
+
1745
+ #### Parameters
1746
+
1747
+ ##### value1
1748
+
1749
+ `any`
1750
+
1751
+ The first value.
1752
+
1753
+ ##### value2
1754
+
1755
+ `any`
1756
+
1757
+ The second value.
1758
+
1759
+ #### Returns
1760
+
1761
+ `boolean`
1762
+
1763
+ ***
1764
+
1765
+ ### isExtensible()
1766
+
1767
+ > `static` **isExtensible**(`o`): `boolean`
1768
+
1769
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:258
1770
+
1771
+ Returns a value that indicates whether new properties can be added to an object.
1772
+
1773
+ #### Parameters
1774
+
1775
+ ##### o
1776
+
1777
+ `any`
1778
+
1779
+ Object to test.
1780
+
1781
+ #### Returns
1782
+
1783
+ `boolean`
1784
+
1785
+ ***
1786
+
1787
+ ### isFrozen()
1788
+
1789
+ > `static` **isFrozen**(`o`): `boolean`
1790
+
1791
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:252
1792
+
1793
+ Returns true if existing property attributes and values cannot be modified in an object, and new properties cannot be added to the object.
1794
+
1795
+ #### Parameters
1796
+
1797
+ ##### o
1798
+
1799
+ `any`
1800
+
1801
+ Object to test.
1802
+
1803
+ #### Returns
1804
+
1805
+ `boolean`
1806
+
1807
+ ***
1808
+
1809
+ ### isSealed()
1810
+
1811
+ > `static` **isSealed**(`o`): `boolean`
1812
+
1813
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:246
1814
+
1815
+ Returns true if existing property attributes cannot be modified in an object and new properties cannot be added to the object.
1816
+
1817
+ #### Parameters
1818
+
1819
+ ##### o
1820
+
1821
+ `any`
1822
+
1823
+ Object to test.
1824
+
1825
+ #### Returns
1826
+
1827
+ `boolean`
1828
+
1829
+ ***
1830
+
1831
+ ### keys()
1832
+
1833
+ #### Call Signature
1834
+
1835
+ > `static` **keys**(`o`): `string`[]
1836
+
1837
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:264
1838
+
1839
+ Returns the names of the enumerable string properties and methods of an object.
1840
+
1841
+ ##### Parameters
1842
+
1843
+ ###### o
1844
+
1845
+ `object`
1846
+
1847
+ Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.
1848
+
1849
+ ##### Returns
1850
+
1851
+ `string`[]
1852
+
1853
+ #### Call Signature
1854
+
1855
+ > `static` **keys**(`o`): `string`[]
1856
+
1857
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:325
1858
+
1859
+ Returns the names of the enumerable string properties and methods of an object.
1860
+
1861
+ ##### Parameters
1862
+
1863
+ ###### o
1864
+
1865
+ Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.
1866
+
1867
+ ##### Returns
1868
+
1869
+ `string`[]
1870
+
1871
+ ***
1872
+
1873
+ ### list()
1874
+
1875
+ > `static` **list**(): [`Funcs`](../interfaces/Funcs.md)
1876
+
1877
+ Defined in: [packages/ai-tool/src/tool-func.ts:63](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L63)
1878
+
1879
+ #### Returns
1880
+
1881
+ [`Funcs`](../interfaces/Funcs.md)
1882
+
1883
+ ***
1884
+
1885
+ ### preventExtensions()
1886
+
1887
+ > `static` **preventExtensions**\<`T`\>(`o`): `T`
1888
+
1889
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:240
1890
+
1891
+ Prevents the addition of new properties to an object.
1892
+
1893
+ #### Type Parameters
1894
+
1895
+ • **T**
1896
+
1897
+ #### Parameters
1898
+
1899
+ ##### o
1900
+
1901
+ `T`
1902
+
1903
+ Object to make non-extensible.
1904
+
1905
+ #### Returns
1906
+
1907
+ `T`
1908
+
1909
+ ***
1910
+
1911
+ ### register()
1912
+
1913
+ #### Call Signature
1914
+
1915
+ > `static` **register**(`name`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
1916
+
1917
+ Defined in: [packages/ai-tool/src/tool-func.ts:154](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L154)
1918
+
1919
+ ##### Parameters
1920
+
1921
+ ###### name
1922
+
1923
+ `string`
1924
+
1925
+ ###### options
1926
+
1927
+ [`FuncItem`](../interfaces/FuncItem.md)
1928
+
1929
+ ##### Returns
1930
+
1931
+ `boolean` \| [`ToolFunc`](ToolFunc.md)
1932
+
1933
+ #### Call Signature
1934
+
1935
+ > `static` **register**(`func`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
1936
+
1937
+ Defined in: [packages/ai-tool/src/tool-func.ts:155](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L155)
1938
+
1939
+ ##### Parameters
1940
+
1941
+ ###### func
1942
+
1943
+ `Function`
1944
+
1945
+ ###### options
1946
+
1947
+ [`FuncItem`](../interfaces/FuncItem.md)
1948
+
1949
+ ##### Returns
1950
+
1951
+ `boolean` \| [`ToolFunc`](ToolFunc.md)
1952
+
1953
+ #### Call Signature
1954
+
1955
+ > `static` **register**(`name`, `options`?): `boolean` \| [`ToolFunc`](ToolFunc.md)
1956
+
1957
+ Defined in: [packages/ai-tool/src/tool-func.ts:156](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L156)
1958
+
1959
+ ##### Parameters
1960
+
1961
+ ###### name
1962
+
1963
+ `string` | `Function` | [`ToolFunc`](ToolFunc.md) | [`FuncItem`](../interfaces/FuncItem.md)
1964
+
1965
+ ###### options?
1966
+
1967
+ [`FuncItem`](../interfaces/FuncItem.md)
1968
+
1969
+ ##### Returns
1970
+
1971
+ `boolean` \| [`ToolFunc`](ToolFunc.md)
1972
+
1973
+ ***
1974
+
1975
+ ### run()
1976
+
1977
+ > `static` **run**(`name`, `params`?): `Promise`\<`any`\>
1978
+
1979
+ Defined in: [packages/ai-tool/src/tool-func.ts:112](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L112)
1980
+
1981
+ #### Parameters
1982
+
1983
+ ##### name
1984
+
1985
+ `string`
1986
+
1987
+ ##### params?
1988
+
1989
+ `any`
1990
+
1991
+ #### Returns
1992
+
1993
+ `Promise`\<`any`\>
1994
+
1995
+ ***
1996
+
1997
+ ### runSync()
1998
+
1999
+ > `static` **runSync**(`name`, `params`?): `any`
2000
+
2001
+ Defined in: [packages/ai-tool/src/tool-func.ts:120](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L120)
2002
+
2003
+ #### Parameters
2004
+
2005
+ ##### name
2006
+
2007
+ `string`
2008
+
2009
+ ##### params?
2010
+
2011
+ `any`
2012
+
2013
+ #### Returns
2014
+
2015
+ `any`
2016
+
2017
+ ***
2018
+
2019
+ ### runWithPos()
2020
+
2021
+ > `static` **runWithPos**(`name`, ...`params`): `Promise`\<`any`\>
2022
+
2023
+ Defined in: [packages/ai-tool/src/tool-func.ts:133](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L133)
2024
+
2025
+ #### Parameters
2026
+
2027
+ ##### name
2028
+
2029
+ `string`
2030
+
2031
+ ##### params
2032
+
2033
+ ...`any`[]
2034
+
2035
+ #### Returns
2036
+
2037
+ `Promise`\<`any`\>
2038
+
2039
+ ***
2040
+
2041
+ ### runWithPosSync()
2042
+
2043
+ > `static` **runWithPosSync**(`name`, ...`params`): `any`
2044
+
2045
+ Defined in: [packages/ai-tool/src/tool-func.ts:141](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L141)
2046
+
2047
+ #### Parameters
2048
+
2049
+ ##### name
2050
+
2051
+ `string`
2052
+
2053
+ ##### params
2054
+
2055
+ ...`any`[]
2056
+
2057
+ #### Returns
2058
+
2059
+ `any`
2060
+
2061
+ ***
2062
+
2063
+ ### seal()
2064
+
2065
+ > `static` **seal**\<`T`\>(`o`): `T`
2066
+
2067
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:216
2068
+
2069
+ Prevents the modification of attributes of existing properties, and prevents the addition of new properties.
2070
+
2071
+ #### Type Parameters
2072
+
2073
+ • **T**
2074
+
2075
+ #### Parameters
2076
+
2077
+ ##### o
2078
+
2079
+ `T`
2080
+
2081
+ Object on which to lock the attributes.
2082
+
2083
+ #### Returns
2084
+
2085
+ `T`
2086
+
2087
+ ***
2088
+
2089
+ ### setPrototypeOf()
2090
+
2091
+ > `static` **setPrototypeOf**(`o`, `proto`): `any`
2092
+
2093
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:339
2094
+
2095
+ Sets the prototype of a specified object o to object proto or null. Returns the object o.
2096
+
2097
+ #### Parameters
2098
+
2099
+ ##### o
2100
+
2101
+ `any`
2102
+
2103
+ The object to change its prototype.
2104
+
2105
+ ##### proto
2106
+
2107
+ The value of the new prototype or null.
2108
+
2109
+ `null` | `object`
2110
+
2111
+ #### Returns
2112
+
2113
+ `any`
2114
+
2115
+ ***
2116
+
2117
+ ### unregister()
2118
+
2119
+ > `static` **unregister**(`name`): `undefined` \| [`ToolFunc`](ToolFunc.md)
2120
+
2121
+ Defined in: [packages/ai-tool/src/tool-func.ts:184](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L184)
2122
+
2123
+ #### Parameters
2124
+
2125
+ ##### name
2126
+
2127
+ `string`
2128
+
2129
+ #### Returns
2130
+
2131
+ `undefined` \| [`ToolFunc`](ToolFunc.md)
2132
+
2133
+ ***
2134
+
2135
+ ### values()
2136
+
2137
+ #### Call Signature
2138
+
2139
+ > `static` **values**\<`T`\>(`o`): `T`[]
2140
+
2141
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2017.object.d.ts:24
2142
+
2143
+ Returns an array of values of the enumerable own properties of an object
2144
+
2145
+ ##### Type Parameters
2146
+
2147
+ • **T**
2148
+
2149
+ ##### Parameters
2150
+
2151
+ ###### o
2152
+
2153
+ Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.
2154
+
2155
+ \{\} | `ArrayLike`\<`T`\>
2156
+
2157
+ ##### Returns
2158
+
2159
+ `T`[]
2160
+
2161
+ #### Call Signature
2162
+
2163
+ > `static` **values**(`o`): `any`[]
2164
+
2165
+ Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2017.object.d.ts:30
2166
+
2167
+ Returns an array of values of the enumerable own properties of an object
2168
+
2169
+ ##### Parameters
2170
+
2171
+ ###### o
2172
+
2173
+ Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.
2174
+
2175
+ ##### Returns
2176
+
2177
+ `any`[]