@isdk/ai-tool 0.5.3 → 0.5.4
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.
- package/docs/classes/BinarySemaphore.md +25 -25
- package/docs/classes/CancelableAbility.md +25 -25
- package/docs/classes/ClientTools.md +55 -55
- package/docs/classes/EnvPromptTemplate.md +19 -19
- package/docs/classes/EventClient.md +78 -78
- package/docs/classes/EventServer.md +79 -79
- package/docs/classes/EventToolFunc.md +47 -47
- package/docs/classes/FStringPromptTemplate.md +19 -19
- package/docs/classes/FewShotPromptTemplate.md +23 -23
- package/docs/classes/GolangPromptTemplate.md +19 -19
- package/docs/classes/HFEnvironment.md +10 -10
- package/docs/classes/HFInterpreter.md +5 -5
- package/docs/classes/HFTemplate.md +5 -5
- package/docs/classes/HfPromptTemplate.md +19 -19
- package/docs/classes/IntSet.md +12 -12
- package/docs/classes/PromptExampleSelector.md +9 -9
- package/docs/classes/PromptTemplate.md +18 -18
- package/docs/classes/ReadableStreamError.md +2 -2
- package/docs/classes/ResClientTools.md +62 -62
- package/docs/classes/ResServerTools.md +63 -63
- package/docs/classes/SSEChannel.md +16 -16
- package/docs/classes/Semaphore.md +26 -26
- package/docs/classes/ServerTools.md +51 -51
- package/docs/classes/SignalGate.md +9 -9
- package/docs/classes/TaskAbortController.md +8 -8
- package/docs/classes/ToolFunc.md +44 -44
- package/docs/classes/YamlTypeBaseObject.md +2 -2
- package/docs/enumerations/AsyncFeatureBits.md +4 -4
- package/docs/enumerations/AsyncFeatures.md +4 -4
- package/docs/enumerations/HashAlgorithm.md +12 -12
- package/docs/functions/AIArgProcessor.md +1 -1
- package/docs/functions/AIStream.md +1 -1
- package/docs/functions/ChoiceArgProcessor.md +1 -1
- package/docs/functions/ObjectArgsToArgsInfo.md +1 -1
- package/docs/functions/RateLimit.md +1 -1
- package/docs/functions/TemplateArgProcessor.md +1 -1
- package/docs/functions/assignDirs.md +1 -1
- package/docs/functions/backendEventable.md +1 -1
- package/docs/functions/beforeShutdown.md +1 -1
- package/docs/functions/completeSentences.md +1 -1
- package/docs/functions/concatText.md +1 -1
- package/docs/functions/countLLMTokens.md +1 -1
- package/docs/functions/countRegexMatches.md +1 -1
- package/docs/functions/createCallbacksTransformer.md +1 -1
- package/docs/functions/createEmptyReadableStream.md +1 -1
- package/docs/functions/createEndWithRepetitionDetector.md +1 -1
- package/docs/functions/createEventStreamTransformer.md +1 -1
- package/docs/functions/createHfValueFunc.md +1 -1
- package/docs/functions/createLRUCache.md +1 -1
- package/docs/functions/createYamlObjectTag.md +1 -1
- package/docs/functions/dateToText.md +1 -1
- package/docs/functions/decodeCharset.md +1 -1
- package/docs/functions/detectCharset.md +1 -1
- package/docs/functions/encodeLLMTokens.md +1 -1
- package/docs/functions/ensureQuoted.md +1 -1
- package/docs/functions/expandConfig.md +1 -1
- package/docs/functions/expandEnv.md +1 -1
- package/docs/functions/expandObjEnv.md +1 -1
- package/docs/functions/expandPath.md +1 -1
- package/docs/functions/extNameLevel.md +1 -1
- package/docs/functions/fileIsExists.md +1 -1
- package/docs/functions/filenameReservedRegex.md +1 -1
- package/docs/functions/filterValidFnScope.md +1 -1
- package/docs/functions/findIndexNonEmptyFrom.md +1 -1
- package/docs/functions/findPort.md +1 -1
- package/docs/functions/formatTextWithSpace.md +1 -1
- package/docs/functions/getAllEnumKeys.md +1 -1
- package/docs/functions/getConfigFileNames.md +1 -1
- package/docs/functions/getConfigs.md +1 -1
- package/docs/functions/getEnvVairables.md +1 -1
- package/docs/functions/getFileMetaInfo.md +1 -1
- package/docs/functions/getHashAlgoBySize.md +1 -1
- package/docs/functions/getKeysPath.md +1 -1
- package/docs/functions/getLLMTokenizer.md +1 -1
- package/docs/functions/getMultiLevelExtname.md +1 -1
- package/docs/functions/getPackageDir.md +1 -1
- package/docs/functions/getRealFilepath.md +1 -1
- package/docs/functions/getResponseErrorReadableStream.md +1 -1
- package/docs/functions/getXDGConfigs.md +1 -1
- package/docs/functions/hasDirectoryIn.md +1 -1
- package/docs/functions/hash.md +1 -1
- package/docs/functions/hashFile.md +1 -1
- package/docs/functions/hashStream.md +1 -1
- package/docs/functions/hfParse.md +1 -1
- package/docs/functions/hfTokenize.md +1 -1
- package/docs/functions/initShutdown.md +1 -1
- package/docs/functions/interpolateEnv.md +1 -1
- package/docs/functions/interpolateFString.md +1 -1
- package/docs/functions/interpolateGolangTemplate.md +1 -1
- package/docs/functions/isLangUsingSpaces.md +1 -1
- package/docs/functions/isListItemString.md +1 -1
- package/docs/functions/isModelNameMatched.md +1 -1
- package/docs/functions/isPunctuationChar.md +1 -1
- package/docs/functions/isQuoted.md +1 -1
- package/docs/functions/isRegExp.md +1 -1
- package/docs/functions/isSameString.md +1 -1
- package/docs/functions/isSectionString.md +1 -1
- package/docs/functions/isSentenceEnding.md +1 -1
- package/docs/functions/isSepLineString.md +1 -1
- package/docs/functions/isStrWrapped.md +1 -1
- package/docs/functions/isSubdirectory.md +1 -1
- package/docs/functions/isTitleString.md +1 -1
- package/docs/functions/isValidFilename.md +1 -1
- package/docs/functions/isValidFilepath.md +1 -1
- package/docs/functions/isWebStream.md +1 -1
- package/docs/functions/jsonFilterToWhere.md +1 -1
- package/docs/functions/jsonToMarkdownStr.md +1 -1
- package/docs/functions/loadAIConfig.md +1 -1
- package/docs/functions/loadConfig.md +1 -1
- package/docs/functions/loadConfigFile.md +1 -1
- package/docs/functions/loadFileFromPaths.md +1 -1
- package/docs/functions/loadTextFromPaths.md +1 -1
- package/docs/functions/lrucache.md +1 -1
- package/docs/functions/makeToolFuncCancelable.md +1 -1
- package/docs/functions/matchUrlProtocol.md +1 -1
- package/docs/functions/memoize.md +1 -1
- package/docs/functions/messagesToText.md +1 -1
- package/docs/functions/paramsSizeToScaleStr.md +1 -1
- package/docs/functions/parseCommand.md +1 -1
- package/docs/functions/parseFString.md +1 -1
- package/docs/functions/parseJsJson.md +1 -1
- package/docs/functions/parseJsJsonSimpleSync.md +1 -1
- package/docs/functions/parseObjectArgInfo.md +1 -1
- package/docs/functions/parseObjectArgumentInfos.md +1 -1
- package/docs/functions/parseObjectArguments.md +1 -1
- package/docs/functions/parseObjectArgumentsAsArgInfos.md +1 -1
- package/docs/functions/parseYaml.md +1 -1
- package/docs/functions/quoteStr.md +1 -1
- package/docs/functions/reControlCharsRegex.md +1 -1
- package/docs/functions/readFilenamesRecursiveSync.md +1 -1
- package/docs/functions/readTextFileChunks.md +1 -1
- package/docs/functions/readTextFileChunksEx.md +1 -1
- package/docs/functions/readableFromAsyncIterable.md +1 -1
- package/docs/functions/registerCoreTools.md +1 -1
- package/docs/functions/registerYamlTag.md +1 -1
- package/docs/functions/removeMarkdownBold.md +1 -1
- package/docs/functions/removeMarkdownBoldAndItalic.md +1 -1
- package/docs/functions/removeMarkdownItalic.md +1 -1
- package/docs/functions/replaceWithPlaceholder.md +1 -1
- package/docs/functions/restoreFromPlacehoders.md +1 -1
- package/docs/functions/sanitizeFilename.md +1 -1
- package/docs/functions/sanitizeFilepath.md +1 -1
- package/docs/functions/saveConfigFile.md +1 -1
- package/docs/functions/scaleStrToParamsSize.md +1 -1
- package/docs/functions/shutdown.md +1 -1
- package/docs/functions/simplifyObjectArguments.md +1 -1
- package/docs/functions/sortedValues.md +1 -1
- package/docs/functions/splitChunks.md +1 -1
- package/docs/functions/splitParagraph.md +1 -1
- package/docs/functions/splitSentence.md +1 -1
- package/docs/functions/stringifyYaml.md +1 -1
- package/docs/functions/stripConsoleColor.md +1 -1
- package/docs/functions/textToDate.md +1 -1
- package/docs/functions/toDateTime.md +1 -1
- package/docs/functions/trimStartOfStreamHelper.md +1 -1
- package/docs/functions/truncTo.md +1 -1
- package/docs/functions/truncateByToken.md +1 -1
- package/docs/functions/truncateToTokenLimit.md +1 -1
- package/docs/functions/truncateToTokenLimitEx.md +1 -1
- package/docs/functions/uuid.md +1 -1
- package/docs/functions/wait.md +1 -1
- package/docs/functions/xxhash.md +1 -1
- package/docs/functions/xxhash32.md +1 -1
- package/docs/functions/xxhash64.md +1 -1
- package/docs/functions/xxhashAsStr.md +1 -1
- package/docs/interfaces/AIChatAssistantMessageParam.md +12 -12
- package/docs/interfaces/AIChatContentPartImage.md +3 -3
- package/docs/interfaces/AIChatContentPartText.md +3 -3
- package/docs/interfaces/AIChatMessageParamBase.md +7 -7
- package/docs/interfaces/AIChatMessageToolCall.md +4 -4
- package/docs/interfaces/AIChatSystemMessageParam.md +9 -9
- package/docs/interfaces/AIChatToolChoiceFuncObject.md +3 -3
- package/docs/interfaces/AIChatToolChoiceObject.md +2 -2
- package/docs/interfaces/AIChatToolFunc.md +5 -5
- package/docs/interfaces/AIChatToolFuncParam.md +3 -3
- package/docs/interfaces/AIChatToolMessageParam.md +10 -10
- package/docs/interfaces/AIChatToolParam.md +2 -2
- package/docs/interfaces/AIChatToolTypeObject.md +2 -2
- package/docs/interfaces/AIChatUserMessageParam.md +13 -13
- package/docs/interfaces/AIChoiceConfig.md +8 -8
- package/docs/interfaces/AIResult.md +6 -6
- package/docs/interfaces/AIStreamParser.md +2 -2
- package/docs/interfaces/AIStreamParserOptions.md +2 -2
- package/docs/interfaces/BaseFunc.md +10 -10
- package/docs/interfaces/BaseFuncItem.md +9 -9
- package/docs/interfaces/BinarySemaphoreAcquireOptions.md +2 -2
- package/docs/interfaces/BinarySemaphoreOptions.md +5 -5
- package/docs/interfaces/BinarySemaphoreReleaseOptions.md +2 -2
- package/docs/interfaces/BinarySemaphoreReleaserFunc.md +3 -3
- package/docs/interfaces/CancelableAbilityOptions.md +4 -4
- package/docs/interfaces/ClientFuncItem.md +12 -12
- package/docs/interfaces/DotenvExpandOptions.md +4 -4
- package/docs/interfaces/DotenvExpandOutput.md +3 -3
- package/docs/interfaces/DotenvParseInput.md +1 -1
- package/docs/interfaces/DotenvParseOutput.md +1 -1
- package/docs/interfaces/DotenvPopulateInput.md +1 -1
- package/docs/interfaces/EventClientFuncParams.md +5 -5
- package/docs/interfaces/EventServerFuncParams.md +6 -6
- package/docs/interfaces/FewShotPromptTemplateOptions.md +12 -12
- package/docs/interfaces/FuncItem.md +10 -10
- package/docs/interfaces/FuncParam.md +7 -7
- package/docs/interfaces/FuncParams.md +1 -1
- package/docs/interfaces/Funcs.md +1 -1
- package/docs/interfaces/HashAlgoParams.md +4 -4
- package/docs/interfaces/IFileMetaInfo.md +8 -8
- package/docs/interfaces/IReadTextFileChunksOptions.md +11 -11
- package/docs/interfaces/ITruncateToTokenLimitOptions.md +10 -10
- package/docs/interfaces/JsonFilter.md +1 -1
- package/docs/interfaces/ParseObjectArgumentOptions.md +11 -11
- package/docs/interfaces/PromptExampleSelectorOptions.md +3 -3
- package/docs/interfaces/PromptTemplateOptions.md +7 -7
- package/docs/interfaces/RemoteFuncItem.md +12 -12
- package/docs/interfaces/ReplacePlacehoderOptions.md +5 -5
- package/docs/interfaces/ResClientFuncParams.md +3 -3
- package/docs/interfaces/ResServerFuncParams.md +6 -6
- package/docs/interfaces/SanitizeFilenameOptions.md +3 -3
- package/docs/interfaces/SectionStringOptions.md +3 -3
- package/docs/interfaces/SemaphoreOptions.md +7 -7
- package/docs/interfaces/SemaphoreTaskItem.md +5 -5
- package/docs/interfaces/ServerFuncItem.md +13 -13
- package/docs/interfaces/ServerFuncParams.md +3 -3
- package/docs/interfaces/SplitSentenceOptions.md +5 -5
- package/docs/interfaces/StreamCallbacksAndOptions.md +5 -5
- package/docs/interfaces/TaskAbortControllers.md +1 -1
- package/docs/interfaces/TaskPromise.md +2 -2
- package/docs/interfaces/ToolFuncPackage.md +4 -4
- package/docs/type-aliases/AIChatContentPart.md +1 -1
- package/docs/type-aliases/AIChatMessageParam.md +1 -1
- package/docs/type-aliases/AIChatRole.md +1 -1
- package/docs/type-aliases/AIChatToolChoiceParam.md +1 -1
- package/docs/type-aliases/AIMessageType.md +1 -1
- package/docs/type-aliases/AIModelNameRule.md +1 -1
- package/docs/type-aliases/AIModelNameRuleFn.md +1 -1
- package/docs/type-aliases/AIModelNameRules.md +1 -1
- package/docs/type-aliases/AITextGenerationFinishReason.md +1 -1
- package/docs/type-aliases/ActionName.md +1 -1
- package/docs/type-aliases/AsyncTaskId.md +1 -1
- package/docs/type-aliases/BeforeShutdownListener.md +1 -1
- package/docs/type-aliases/EventErrorListenerFn.md +1 -1
- package/docs/type-aliases/EventListenerFn.md +1 -1
- package/docs/type-aliases/FStringPromptTemplateNode.md +1 -1
- package/docs/type-aliases/FuncParamType.md +1 -1
- package/docs/type-aliases/PromptExamples.md +1 -1
- package/docs/type-aliases/PromptTemplateType.md +1 -1
- package/docs/type-aliases/PromptType.md +1 -1
- package/docs/type-aliases/SemaphoreIsReadyFuncType.md +1 -1
- package/docs/type-aliases/TFunc.md +1 -1
- package/docs/variables/AIChatRoles.md +1 -1
- package/docs/variables/AIMessageTypes.md +1 -1
- package/docs/variables/AITextGenerationFinishReasons.md +1 -1
- package/docs/variables/ActionNames.md +1 -1
- package/docs/variables/ClientToolFuncSchema.md +1 -1
- package/docs/variables/DEFAULT_CONFIG_NAME.md +1 -1
- package/docs/variables/DefaultAsyncSemaphoreCapacity.md +1 -1
- package/docs/variables/EventBusName.md +1 -1
- package/docs/variables/EventName.md +1 -1
- package/docs/variables/FilenameReservedRegex.md +1 -1
- package/docs/variables/HFBuiltins.md +1 -1
- package/docs/variables/LLM_TOKENIZER_NAMES.md +1 -1
- package/docs/variables/LLM_TOKENIZER_NAMES_MAP.md +1 -1
- package/docs/variables/PASSING_SCORE.md +1 -1
- package/docs/variables/PromptTemplateTypes.md +1 -1
- package/docs/variables/PromptTypes.md +1 -1
- package/docs/variables/RStreamErrCode.md +1 -1
- package/docs/variables/RemoteToolFuncSchema.md +1 -1
- package/docs/variables/ResponseRStreamErrCode.md +1 -1
- package/docs/variables/SHUTDOWN_SIGNALS.md +1 -1
- package/docs/variables/SSEChannelAlreadyClosedErrCode.md +1 -1
- package/docs/variables/SecondaryCache.md +1 -1
- package/docs/variables/ServerToolFuncSchema.md +1 -1
- package/docs/variables/ToolAsyncCancelableBit.md +1 -1
- package/docs/variables/ToolAsyncMultiTaskBit.md +1 -1
- package/docs/variables/ToolAsyncPriorityBit.md +1 -1
- package/docs/variables/ToolFuncSchema.md +1 -1
- package/docs/variables/WindowsReservedNameRegex.md +1 -1
- package/docs/variables/base32768.md +1 -1
- package/docs/variables/defaultTemplateFormat.md +1 -1
- package/docs/variables/event.md +1 -1
- package/docs/variables/eventClient.md +1 -1
- package/docs/variables/eventServer.md +1 -1
- package/docs/variables/lrucache.md +1 -1
- package/package.json +1 -1
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: ServerTools
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/ai-tool/src/server-tools.ts:17](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [packages/ai-tool/src/server-tools.ts:17](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/server-tools.ts#L17)
|
|
10
10
|
|
|
11
11
|
## Extends
|
|
12
12
|
|
|
@@ -22,7 +22,7 @@ Defined in: [packages/ai-tool/src/server-tools.ts:17](https://github.com/isdk/ai
|
|
|
22
22
|
|
|
23
23
|
> **new ServerTools**(`name`, `options`): [`ServerTools`](ServerTools.md)
|
|
24
24
|
|
|
25
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:192](https://github.com/isdk/ai-tool.js/blob/
|
|
25
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:192](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L192)
|
|
26
26
|
|
|
27
27
|
The initial value of Object.prototype.constructor is the standard built-in Object constructor.
|
|
28
28
|
|
|
@@ -62,7 +62,7 @@ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-ma
|
|
|
62
62
|
|
|
63
63
|
> `optional` **action**: `"get"` \| `"post"` \| `"put"` \| `"delete"` \| `"patch"` \| `"list"` \| `"res"`
|
|
64
64
|
|
|
65
|
-
Defined in: [packages/ai-tool/src/utils/consts.ts:35](https://github.com/isdk/ai-tool.js/blob/
|
|
65
|
+
Defined in: [packages/ai-tool/src/utils/consts.ts:35](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/consts.ts#L35)
|
|
66
66
|
|
|
67
67
|
#### Inherited from
|
|
68
68
|
|
|
@@ -74,7 +74,7 @@ Defined in: [packages/ai-tool/src/utils/consts.ts:35](https://github.com/isdk/ai
|
|
|
74
74
|
|
|
75
75
|
> `optional` **allowExportFunc**: `boolean`
|
|
76
76
|
|
|
77
|
-
Defined in: [packages/ai-tool/src/server-tools.ts:14](https://github.com/isdk/ai-tool.js/blob/
|
|
77
|
+
Defined in: [packages/ai-tool/src/server-tools.ts:14](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/server-tools.ts#L14)
|
|
78
78
|
|
|
79
79
|
#### Inherited from
|
|
80
80
|
|
|
@@ -86,7 +86,7 @@ Defined in: [packages/ai-tool/src/server-tools.ts:14](https://github.com/isdk/ai
|
|
|
86
86
|
|
|
87
87
|
> `optional` **apiRoot**: `string`
|
|
88
88
|
|
|
89
|
-
Defined in: [packages/ai-tool/src/utils/consts.ts:34](https://github.com/isdk/ai-tool.js/blob/
|
|
89
|
+
Defined in: [packages/ai-tool/src/utils/consts.ts:34](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/consts.ts#L34)
|
|
90
90
|
|
|
91
91
|
#### Inherited from
|
|
92
92
|
|
|
@@ -130,7 +130,7 @@ The default options for export and assign
|
|
|
130
130
|
|
|
131
131
|
> `optional` **fetchOptions**: `any`
|
|
132
132
|
|
|
133
|
-
Defined in: [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai-tool.js/blob/
|
|
133
|
+
Defined in: [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/consts.ts#L36)
|
|
134
134
|
|
|
135
135
|
#### Inherited from
|
|
136
136
|
|
|
@@ -142,7 +142,7 @@ Defined in: [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai
|
|
|
142
142
|
|
|
143
143
|
> `optional` **isApi**: `boolean`
|
|
144
144
|
|
|
145
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-tool.js/blob/
|
|
145
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L29)
|
|
146
146
|
|
|
147
147
|
#### Inherited from
|
|
148
148
|
|
|
@@ -154,7 +154,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-to
|
|
|
154
154
|
|
|
155
155
|
> `optional` **name**: `string`
|
|
156
156
|
|
|
157
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/
|
|
157
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L23)
|
|
158
158
|
|
|
159
159
|
#### Inherited from
|
|
160
160
|
|
|
@@ -180,7 +180,7 @@ the property with the default prefix '$' will not be exported.
|
|
|
180
180
|
|
|
181
181
|
> `optional` **params**: [`FuncParams`](../interfaces/FuncParams.md) \| [`FuncParam`](../interfaces/FuncParam.md)[]
|
|
182
182
|
|
|
183
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/
|
|
183
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L24)
|
|
184
184
|
|
|
185
185
|
#### Inherited from
|
|
186
186
|
|
|
@@ -192,7 +192,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-to
|
|
|
192
192
|
|
|
193
193
|
> `optional` **result**: `string`
|
|
194
194
|
|
|
195
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-tool.js/blob/
|
|
195
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L25)
|
|
196
196
|
|
|
197
197
|
#### Inherited from
|
|
198
198
|
|
|
@@ -204,7 +204,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-to
|
|
|
204
204
|
|
|
205
205
|
> `optional` **scope**: `any`
|
|
206
206
|
|
|
207
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/
|
|
207
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L26)
|
|
208
208
|
|
|
209
209
|
#### Inherited from
|
|
210
210
|
|
|
@@ -216,7 +216,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-to
|
|
|
216
216
|
|
|
217
217
|
> `optional` **setup**: (`this`, `options`?) => `void`
|
|
218
218
|
|
|
219
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-tool.js/blob/
|
|
219
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L28)
|
|
220
220
|
|
|
221
221
|
#### Parameters
|
|
222
222
|
|
|
@@ -242,7 +242,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-to
|
|
|
242
242
|
|
|
243
243
|
> `optional` **stream**: `boolean`
|
|
244
244
|
|
|
245
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-tool.js/blob/
|
|
245
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L30)
|
|
246
246
|
|
|
247
247
|
#### Inherited from
|
|
248
248
|
|
|
@@ -254,7 +254,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-to
|
|
|
254
254
|
|
|
255
255
|
> `optional` **tags**: `string` \| `string`[]
|
|
256
256
|
|
|
257
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-tool.js/blob/
|
|
257
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L27)
|
|
258
258
|
|
|
259
259
|
#### Inherited from
|
|
260
260
|
|
|
@@ -266,7 +266,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-to
|
|
|
266
266
|
|
|
267
267
|
> `static` **dataPath**: `string`
|
|
268
268
|
|
|
269
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:57](https://github.com/isdk/ai-tool.js/blob/
|
|
269
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:57](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L57)
|
|
270
270
|
|
|
271
271
|
#### Inherited from
|
|
272
272
|
|
|
@@ -278,7 +278,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:57](https://github.com/isdk/ai-to
|
|
|
278
278
|
|
|
279
279
|
> `static` **items**: [`Funcs`](../interfaces/Funcs.md) = `{}`
|
|
280
280
|
|
|
281
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:56](https://github.com/isdk/ai-tool.js/blob/
|
|
281
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:56](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L56)
|
|
282
282
|
|
|
283
283
|
#### Inherited from
|
|
284
284
|
|
|
@@ -292,7 +292,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:56](https://github.com/isdk/ai-to
|
|
|
292
292
|
|
|
293
293
|
> **get** `static` **apiRoot**(): `undefined` \| `string`
|
|
294
294
|
|
|
295
|
-
Defined in: [packages/ai-tool/src/server-tools.ts:26](https://github.com/isdk/ai-tool.js/blob/
|
|
295
|
+
Defined in: [packages/ai-tool/src/server-tools.ts:26](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/server-tools.ts#L26)
|
|
296
296
|
|
|
297
297
|
##### Returns
|
|
298
298
|
|
|
@@ -308,7 +308,7 @@ Defined in: [packages/ai-tool/src/server-tools.ts:26](https://github.com/isdk/ai
|
|
|
308
308
|
|
|
309
309
|
> **arr2ObjParams**(`params`): `any`[]
|
|
310
310
|
|
|
311
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:236](https://github.com/isdk/ai-tool.js/blob/
|
|
311
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:236](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L236)
|
|
312
312
|
|
|
313
313
|
#### Parameters
|
|
314
314
|
|
|
@@ -612,7 +612,7 @@ the dest object.
|
|
|
612
612
|
|
|
613
613
|
> **func**(`__namedParameters`): `any`
|
|
614
614
|
|
|
615
|
-
Defined in: [packages/ai-tool/src/server-tools.ts:59](https://github.com/isdk/ai-tool.js/blob/
|
|
615
|
+
Defined in: [packages/ai-tool/src/server-tools.ts:59](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/server-tools.ts#L59)
|
|
616
616
|
|
|
617
617
|
#### Parameters
|
|
618
618
|
|
|
@@ -632,7 +632,7 @@ Defined in: [packages/ai-tool/src/server-tools.ts:59](https://github.com/isdk/ai
|
|
|
632
632
|
|
|
633
633
|
> **getFunc**(`name`?): `any`
|
|
634
634
|
|
|
635
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:289](https://github.com/isdk/ai-tool.js/blob/
|
|
635
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:289](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L289)
|
|
636
636
|
|
|
637
637
|
#### Parameters
|
|
638
638
|
|
|
@@ -654,7 +654,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:289](https://github.com/isdk/ai-t
|
|
|
654
654
|
|
|
655
655
|
> **getFuncWithPos**(`name`?): `any`
|
|
656
656
|
|
|
657
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:313](https://github.com/isdk/ai-tool.js/blob/
|
|
657
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:313](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L313)
|
|
658
658
|
|
|
659
659
|
#### Parameters
|
|
660
660
|
|
|
@@ -696,7 +696,7 @@ the descriptors of properties object
|
|
|
696
696
|
|
|
697
697
|
> **hasAsyncFeature**(`feature`): `boolean`
|
|
698
698
|
|
|
699
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:318](https://github.com/isdk/ai-tool.js/blob/
|
|
699
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:318](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L318)
|
|
700
700
|
|
|
701
701
|
#### Parameters
|
|
702
702
|
|
|
@@ -826,7 +826,7 @@ The source object
|
|
|
826
826
|
|
|
827
827
|
> **isStream**(`params`): `undefined` \| `boolean`
|
|
828
828
|
|
|
829
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:324](https://github.com/isdk/ai-tool.js/blob/
|
|
829
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:324](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L324)
|
|
830
830
|
|
|
831
831
|
#### Parameters
|
|
832
832
|
|
|
@@ -880,7 +880,7 @@ the dest object.
|
|
|
880
880
|
|
|
881
881
|
> **obj2ArrParams**(`params`?): `any`[]
|
|
882
882
|
|
|
883
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:249](https://github.com/isdk/ai-tool.js/blob/
|
|
883
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:249](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L249)
|
|
884
884
|
|
|
885
885
|
#### Parameters
|
|
886
886
|
|
|
@@ -928,7 +928,7 @@ A property name.
|
|
|
928
928
|
|
|
929
929
|
> **register**(): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
930
930
|
|
|
931
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:219](https://github.com/isdk/ai-tool.js/blob/
|
|
931
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:219](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L219)
|
|
932
932
|
|
|
933
933
|
#### Returns
|
|
934
934
|
|
|
@@ -944,7 +944,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:219](https://github.com/isdk/ai-t
|
|
|
944
944
|
|
|
945
945
|
> **run**(`params`?): `Promise`\<`any`\>
|
|
946
946
|
|
|
947
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:276](https://github.com/isdk/ai-tool.js/blob/
|
|
947
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:276](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L276)
|
|
948
948
|
|
|
949
949
|
#### Parameters
|
|
950
950
|
|
|
@@ -966,7 +966,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:276](https://github.com/isdk/ai-t
|
|
|
966
966
|
|
|
967
967
|
> **runAs**(`name`, `params`?): `Promise`\<`any`\>
|
|
968
968
|
|
|
969
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:280](https://github.com/isdk/ai-tool.js/blob/
|
|
969
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:280](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L280)
|
|
970
970
|
|
|
971
971
|
#### Parameters
|
|
972
972
|
|
|
@@ -992,7 +992,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:280](https://github.com/isdk/ai-t
|
|
|
992
992
|
|
|
993
993
|
> **runAsSync**(`name`, `params`?): `any`
|
|
994
994
|
|
|
995
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:284](https://github.com/isdk/ai-tool.js/blob/
|
|
995
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:284](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L284)
|
|
996
996
|
|
|
997
997
|
#### Parameters
|
|
998
998
|
|
|
@@ -1018,7 +1018,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:284](https://github.com/isdk/ai-t
|
|
|
1018
1018
|
|
|
1019
1019
|
> **runSync**(`params`?): `any`
|
|
1020
1020
|
|
|
1021
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:262](https://github.com/isdk/ai-tool.js/blob/
|
|
1021
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:262](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L262)
|
|
1022
1022
|
|
|
1023
1023
|
#### Parameters
|
|
1024
1024
|
|
|
@@ -1040,7 +1040,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:262](https://github.com/isdk/ai-t
|
|
|
1040
1040
|
|
|
1041
1041
|
> **runWithPos**(...`params`): `Promise`\<`any`\>
|
|
1042
1042
|
|
|
1043
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:305](https://github.com/isdk/ai-tool.js/blob/
|
|
1043
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:305](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L305)
|
|
1044
1044
|
|
|
1045
1045
|
#### Parameters
|
|
1046
1046
|
|
|
@@ -1062,7 +1062,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:305](https://github.com/isdk/ai-t
|
|
|
1062
1062
|
|
|
1063
1063
|
> **runWithPosAs**(`name`, ...`params`): `Promise`\<`any`\>
|
|
1064
1064
|
|
|
1065
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:309](https://github.com/isdk/ai-tool.js/blob/
|
|
1065
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:309](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L309)
|
|
1066
1066
|
|
|
1067
1067
|
#### Parameters
|
|
1068
1068
|
|
|
@@ -1088,7 +1088,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:309](https://github.com/isdk/ai-t
|
|
|
1088
1088
|
|
|
1089
1089
|
> **runWithPosAsSync**(`name`, ...`params`): `any`
|
|
1090
1090
|
|
|
1091
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:301](https://github.com/isdk/ai-tool.js/blob/
|
|
1091
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:301](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L301)
|
|
1092
1092
|
|
|
1093
1093
|
#### Parameters
|
|
1094
1094
|
|
|
@@ -1114,7 +1114,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:301](https://github.com/isdk/ai-t
|
|
|
1114
1114
|
|
|
1115
1115
|
> **runWithPosSync**(...`params`): `any`
|
|
1116
1116
|
|
|
1117
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:294](https://github.com/isdk/ai-tool.js/blob/
|
|
1117
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:294](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L294)
|
|
1118
1118
|
|
|
1119
1119
|
#### Parameters
|
|
1120
1120
|
|
|
@@ -1214,7 +1214,7 @@ Returns a string representation of an object.
|
|
|
1214
1214
|
|
|
1215
1215
|
> **unregister**(): `any`
|
|
1216
1216
|
|
|
1217
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:232](https://github.com/isdk/ai-tool.js/blob/
|
|
1217
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:232](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L232)
|
|
1218
1218
|
|
|
1219
1219
|
#### Returns
|
|
1220
1220
|
|
|
@@ -1750,7 +1750,7 @@ An iterable object that contains key-value entries for properties and methods.
|
|
|
1750
1750
|
|
|
1751
1751
|
> `static` **get**(`name`): [`ToolFunc`](ToolFunc.md)
|
|
1752
1752
|
|
|
1753
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:59](https://github.com/isdk/ai-tool.js/blob/
|
|
1753
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:59](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L59)
|
|
1754
1754
|
|
|
1755
1755
|
#### Parameters
|
|
1756
1756
|
|
|
@@ -1772,7 +1772,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:59](https://github.com/isdk/ai-to
|
|
|
1772
1772
|
|
|
1773
1773
|
> `static` **getAllByTag**(`tagName`): [`ToolFunc`](ToolFunc.md)[]
|
|
1774
1774
|
|
|
1775
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:87](https://github.com/isdk/ai-tool.js/blob/
|
|
1775
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:87](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L87)
|
|
1776
1776
|
|
|
1777
1777
|
#### Parameters
|
|
1778
1778
|
|
|
@@ -1794,7 +1794,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:87](https://github.com/isdk/ai-to
|
|
|
1794
1794
|
|
|
1795
1795
|
> `static` **getByTag**(`tagName`): `undefined` \| [`ToolFunc`](ToolFunc.md)
|
|
1796
1796
|
|
|
1797
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:67](https://github.com/isdk/ai-tool.js/blob/
|
|
1797
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:67](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L67)
|
|
1798
1798
|
|
|
1799
1799
|
#### Parameters
|
|
1800
1800
|
|
|
@@ -1816,7 +1816,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:67](https://github.com/isdk/ai-to
|
|
|
1816
1816
|
|
|
1817
1817
|
> `static` **getFunc**(`name`): `any`
|
|
1818
1818
|
|
|
1819
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:128](https://github.com/isdk/ai-tool.js/blob/
|
|
1819
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:128](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L128)
|
|
1820
1820
|
|
|
1821
1821
|
#### Parameters
|
|
1822
1822
|
|
|
@@ -1838,7 +1838,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:128](https://github.com/isdk/ai-t
|
|
|
1838
1838
|
|
|
1839
1839
|
> `static` **getFuncWithPos**(`name`): `any`
|
|
1840
1840
|
|
|
1841
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:149](https://github.com/isdk/ai-tool.js/blob/
|
|
1841
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:149](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L149)
|
|
1842
1842
|
|
|
1843
1843
|
#### Parameters
|
|
1844
1844
|
|
|
@@ -2020,7 +2020,7 @@ The object that references the prototype.
|
|
|
2020
2020
|
|
|
2021
2021
|
> `static` **hasAsyncFeature**(`feature`): `boolean`
|
|
2022
2022
|
|
|
2023
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:105](https://github.com/isdk/ai-tool.js/blob/
|
|
2023
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:105](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L105)
|
|
2024
2024
|
|
|
2025
2025
|
#### Parameters
|
|
2026
2026
|
|
|
@@ -2234,7 +2234,7 @@ Object that contains the properties and methods. This can be an object that you
|
|
|
2234
2234
|
|
|
2235
2235
|
> `static` **list**(): [`Funcs`](../interfaces/Funcs.md)
|
|
2236
2236
|
|
|
2237
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:63](https://github.com/isdk/ai-tool.js/blob/
|
|
2237
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:63](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L63)
|
|
2238
2238
|
|
|
2239
2239
|
#### Returns
|
|
2240
2240
|
|
|
@@ -2282,7 +2282,7 @@ Object to make non-extensible.
|
|
|
2282
2282
|
|
|
2283
2283
|
> `static` **register**(`name`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2284
2284
|
|
|
2285
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:154](https://github.com/isdk/ai-tool.js/blob/
|
|
2285
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:154](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L154)
|
|
2286
2286
|
|
|
2287
2287
|
##### Parameters
|
|
2288
2288
|
|
|
@@ -2306,7 +2306,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:154](https://github.com/isdk/ai-t
|
|
|
2306
2306
|
|
|
2307
2307
|
> `static` **register**(`func`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2308
2308
|
|
|
2309
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:155](https://github.com/isdk/ai-tool.js/blob/
|
|
2309
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:155](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L155)
|
|
2310
2310
|
|
|
2311
2311
|
##### Parameters
|
|
2312
2312
|
|
|
@@ -2330,7 +2330,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:155](https://github.com/isdk/ai-t
|
|
|
2330
2330
|
|
|
2331
2331
|
> `static` **register**(`name`, `options`?): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2332
2332
|
|
|
2333
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:156](https://github.com/isdk/ai-tool.js/blob/
|
|
2333
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:156](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L156)
|
|
2334
2334
|
|
|
2335
2335
|
##### Parameters
|
|
2336
2336
|
|
|
@@ -2356,7 +2356,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:156](https://github.com/isdk/ai-t
|
|
|
2356
2356
|
|
|
2357
2357
|
> `static` **run**(`name`, `params`?): `Promise`\<`any`\>
|
|
2358
2358
|
|
|
2359
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:112](https://github.com/isdk/ai-tool.js/blob/
|
|
2359
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:112](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L112)
|
|
2360
2360
|
|
|
2361
2361
|
#### Parameters
|
|
2362
2362
|
|
|
@@ -2382,7 +2382,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:112](https://github.com/isdk/ai-t
|
|
|
2382
2382
|
|
|
2383
2383
|
> `static` **runSync**(`name`, `params`?): `any`
|
|
2384
2384
|
|
|
2385
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:120](https://github.com/isdk/ai-tool.js/blob/
|
|
2385
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:120](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L120)
|
|
2386
2386
|
|
|
2387
2387
|
#### Parameters
|
|
2388
2388
|
|
|
@@ -2408,7 +2408,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:120](https://github.com/isdk/ai-t
|
|
|
2408
2408
|
|
|
2409
2409
|
> `static` **runWithPos**(`name`, ...`params`): `Promise`\<`any`\>
|
|
2410
2410
|
|
|
2411
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:133](https://github.com/isdk/ai-tool.js/blob/
|
|
2411
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:133](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L133)
|
|
2412
2412
|
|
|
2413
2413
|
#### Parameters
|
|
2414
2414
|
|
|
@@ -2434,7 +2434,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:133](https://github.com/isdk/ai-t
|
|
|
2434
2434
|
|
|
2435
2435
|
> `static` **runWithPosSync**(`name`, ...`params`): `any`
|
|
2436
2436
|
|
|
2437
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:141](https://github.com/isdk/ai-tool.js/blob/
|
|
2437
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:141](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L141)
|
|
2438
2438
|
|
|
2439
2439
|
#### Parameters
|
|
2440
2440
|
|
|
@@ -2490,7 +2490,7 @@ Object on which to lock the attributes.
|
|
|
2490
2490
|
|
|
2491
2491
|
> `static` **setApiRoot**(`v`): `void`
|
|
2492
2492
|
|
|
2493
|
-
Defined in: [packages/ai-tool/src/server-tools.ts:30](https://github.com/isdk/ai-tool.js/blob/
|
|
2493
|
+
Defined in: [packages/ai-tool/src/server-tools.ts:30](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/server-tools.ts#L30)
|
|
2494
2494
|
|
|
2495
2495
|
#### Parameters
|
|
2496
2496
|
|
|
@@ -2540,7 +2540,7 @@ The value of the new prototype or null.
|
|
|
2540
2540
|
|
|
2541
2541
|
> `static` **toJSON**(): `object`
|
|
2542
2542
|
|
|
2543
|
-
Defined in: [packages/ai-tool/src/server-tools.ts:44](https://github.com/isdk/ai-tool.js/blob/
|
|
2543
|
+
Defined in: [packages/ai-tool/src/server-tools.ts:44](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/server-tools.ts#L44)
|
|
2544
2544
|
|
|
2545
2545
|
#### Returns
|
|
2546
2546
|
|
|
@@ -2552,7 +2552,7 @@ Defined in: [packages/ai-tool/src/server-tools.ts:44](https://github.com/isdk/ai
|
|
|
2552
2552
|
|
|
2553
2553
|
> `static` **unregister**(`name`): `undefined` \| [`ToolFunc`](ToolFunc.md)
|
|
2554
2554
|
|
|
2555
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:184](https://github.com/isdk/ai-tool.js/blob/
|
|
2555
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:184](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L184)
|
|
2556
2556
|
|
|
2557
2557
|
#### Parameters
|
|
2558
2558
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: SignalGate\<T\>
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:20](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:20](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/async-signal-gate.ts#L20)
|
|
10
10
|
|
|
11
11
|
An asynchronous signal gate that blocks operations until a signal is emitted.
|
|
12
12
|
This class allows multiple awaiters to wait for a signal and resolves all pending promises with the emitted value.
|
|
@@ -44,7 +44,7 @@ valueGate.signal(42); // Must provide a number value
|
|
|
44
44
|
|
|
45
45
|
> `protected` **\_isSignaled**: `boolean` = `false`
|
|
46
46
|
|
|
47
|
-
Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:21](https://github.com/isdk/ai-tool.js/blob/
|
|
47
|
+
Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:21](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/async-signal-gate.ts#L21)
|
|
48
48
|
|
|
49
49
|
***
|
|
50
50
|
|
|
@@ -52,7 +52,7 @@ Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:21](https://github.
|
|
|
52
52
|
|
|
53
53
|
> `protected` **\_signalValue**: `undefined` \| `T`
|
|
54
54
|
|
|
55
|
-
Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:22](https://github.com/isdk/ai-tool.js/blob/
|
|
55
|
+
Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:22](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/async-signal-gate.ts#L22)
|
|
56
56
|
|
|
57
57
|
***
|
|
58
58
|
|
|
@@ -60,7 +60,7 @@ Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:22](https://github.
|
|
|
60
60
|
|
|
61
61
|
> `protected` **waitQueue**: `object`[] = `[]`
|
|
62
62
|
|
|
63
|
-
Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:23](https://github.com/isdk/ai-tool.js/blob/
|
|
63
|
+
Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:23](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/async-signal-gate.ts#L23)
|
|
64
64
|
|
|
65
65
|
#### reject()
|
|
66
66
|
|
|
@@ -98,7 +98,7 @@ Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:23](https://github.
|
|
|
98
98
|
|
|
99
99
|
> **get** **signaled**(): `boolean`
|
|
100
100
|
|
|
101
|
-
Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:28](https://github.com/isdk/ai-tool.js/blob/
|
|
101
|
+
Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:28](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/async-signal-gate.ts#L28)
|
|
102
102
|
|
|
103
103
|
##### Returns
|
|
104
104
|
|
|
@@ -110,7 +110,7 @@ Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:28](https://github.
|
|
|
110
110
|
|
|
111
111
|
> **abort**(`reason`?): `void`
|
|
112
112
|
|
|
113
|
-
Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:65](https://github.com/isdk/ai-tool.js/blob/
|
|
113
|
+
Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:65](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/async-signal-gate.ts#L65)
|
|
114
114
|
|
|
115
115
|
Aborts all pending waits, rejecting their promises with an error.
|
|
116
116
|
This does **not** reset the signal state (the gate remains signaled or unsignaled).
|
|
@@ -133,7 +133,7 @@ The reason for aborting the waits.
|
|
|
133
133
|
|
|
134
134
|
> **reset**(): `void`
|
|
135
135
|
|
|
136
|
-
Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:53](https://github.com/isdk/ai-tool.js/blob/
|
|
136
|
+
Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:53](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/async-signal-gate.ts#L53)
|
|
137
137
|
|
|
138
138
|
Resets the gate to its initial state, allowing a new signal to be emitted.
|
|
139
139
|
|
|
@@ -147,7 +147,7 @@ Resets the gate to its initial state, allowing a new signal to be emitted.
|
|
|
147
147
|
|
|
148
148
|
> **signal**(`value`?): `void`
|
|
149
149
|
|
|
150
|
-
Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:38](https://github.com/isdk/ai-tool.js/blob/
|
|
150
|
+
Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:38](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/async-signal-gate.ts#L38)
|
|
151
151
|
|
|
152
152
|
Emits the signal with an optional value, resolving all pending [wait](../functions/wait.md) promises.
|
|
153
153
|
Subsequent calls have no effect until [reset](SignalGate.md#reset) is called.
|
|
@@ -170,7 +170,7 @@ The value to emit with the signal (only required if T is not void).
|
|
|
170
170
|
|
|
171
171
|
> **wait**(): `Promise`\<`T`\>
|
|
172
172
|
|
|
173
|
-
Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:83](https://github.com/isdk/ai-tool.js/blob/
|
|
173
|
+
Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:83](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/async-signal-gate.ts#L83)
|
|
174
174
|
|
|
175
175
|
Returns a promise that resolves with the emitted signal value.
|
|
176
176
|
If called after the signal has been emitted, resolves immediately with the stored value.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: TaskAbortController
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:35](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:35](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L35)
|
|
10
10
|
|
|
11
11
|
## Extends
|
|
12
12
|
|
|
@@ -18,7 +18,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:35](https://github
|
|
|
18
18
|
|
|
19
19
|
> **new TaskAbortController**(`parent`): [`TaskAbortController`](TaskAbortController.md)
|
|
20
20
|
|
|
21
|
-
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:41](https://github.com/isdk/ai-tool.js/blob/
|
|
21
|
+
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:41](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L41)
|
|
22
22
|
|
|
23
23
|
#### Parameters
|
|
24
24
|
|
|
@@ -40,7 +40,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:41](https://github
|
|
|
40
40
|
|
|
41
41
|
> `optional` **id**: [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
|
|
42
42
|
|
|
43
|
-
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:36](https://github.com/isdk/ai-tool.js/blob/
|
|
43
|
+
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:36](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L36)
|
|
44
44
|
|
|
45
45
|
***
|
|
46
46
|
|
|
@@ -48,7 +48,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:36](https://github
|
|
|
48
48
|
|
|
49
49
|
> **parent**: [`CancelableAbility`](CancelableAbility.md)
|
|
50
50
|
|
|
51
|
-
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:39](https://github.com/isdk/ai-tool.js/blob/
|
|
51
|
+
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:39](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L39)
|
|
52
52
|
|
|
53
53
|
***
|
|
54
54
|
|
|
@@ -72,7 +72,7 @@ Returns the AbortSignal object associated with this object.
|
|
|
72
72
|
|
|
73
73
|
> `optional` **streamController**: `ReadableStreamDefaultController`\<`any`\>
|
|
74
74
|
|
|
75
|
-
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:38](https://github.com/isdk/ai-tool.js/blob/
|
|
75
|
+
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:38](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L38)
|
|
76
76
|
|
|
77
77
|
***
|
|
78
78
|
|
|
@@ -80,7 +80,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:38](https://github
|
|
|
80
80
|
|
|
81
81
|
> `optional` **timeoutId**: `any`
|
|
82
82
|
|
|
83
|
-
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:37](https://github.com/isdk/ai-tool.js/blob/
|
|
83
|
+
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:37](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L37)
|
|
84
84
|
|
|
85
85
|
## Methods
|
|
86
86
|
|
|
@@ -88,7 +88,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:37](https://github
|
|
|
88
88
|
|
|
89
89
|
> **abort**(`reason`?, `data`?): `void`
|
|
90
90
|
|
|
91
|
-
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:46](https://github.com/isdk/ai-tool.js/blob/
|
|
91
|
+
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:46](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L46)
|
|
92
92
|
|
|
93
93
|
Invoking this method will set this object's AbortSignal's aborted flag and signal to any observers that the associated activity is to be aborted.
|
|
94
94
|
|
|
@@ -118,7 +118,7 @@ Invoking this method will set this object's AbortSignal's aborted flag and signa
|
|
|
118
118
|
|
|
119
119
|
> **throwRejected**(`alreadyRejected`?): `undefined` \| `true`
|
|
120
120
|
|
|
121
|
-
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:55](https://github.com/isdk/ai-tool.js/blob/
|
|
121
|
+
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:55](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L55)
|
|
122
122
|
|
|
123
123
|
#### Parameters
|
|
124
124
|
|