@isdk/ai-tool 0.5.8 → 0.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/chunk-OYDBRUZJ.mjs +1 -0
- package/dist/funcs.js +1 -1
- package/dist/funcs.mjs +1 -1
- package/dist/index.d.mts +11 -637
- package/dist/index.d.ts +11 -637
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/docs/classes/BinarySemaphore.md +25 -25
- package/docs/classes/CancelableAbility.md +25 -25
- package/docs/classes/ClientTools.md +57 -57
- package/docs/classes/ConfigFile.md +78 -262
- package/docs/classes/EnvPromptTemplate.md +233 -36
- package/docs/classes/EventClient.md +80 -80
- package/docs/classes/EventServer.md +81 -81
- package/docs/classes/EventToolFunc.md +49 -49
- package/docs/classes/FStringPromptTemplate.md +234 -37
- package/docs/classes/FewShotPromptTemplate.md +213 -34
- package/docs/classes/GolangPromptTemplate.md +230 -33
- package/docs/classes/IntSet.md +12 -12
- package/docs/classes/PromptExampleSelector.md +9 -9
- package/docs/classes/PromptTemplate.md +230 -34
- package/docs/classes/ReadableStreamError.md +2 -2
- package/docs/classes/ResClientTools.md +64 -64
- package/docs/classes/ResServerTools.md +65 -65
- package/docs/classes/SSEChannel.md +16 -16
- package/docs/classes/Semaphore.md +26 -26
- package/docs/classes/ServerTools.md +53 -53
- package/docs/classes/SignalGate.md +9 -9
- package/docs/classes/TaskAbortController.md +8 -8
- package/docs/classes/ToolFunc.md +46 -46
- 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 +3 -3
- package/docs/functions/expandEnv.md +4 -4
- package/docs/functions/expandObjEnv.md +4 -4
- package/docs/functions/expandPath.md +1 -1
- package/docs/functions/extNameLevel.md +1 -1
- package/docs/functions/fileIsExists.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 +4 -4
- 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/initShutdown.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/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 +21 -1
- package/docs/functions/quoteStr.md +1 -1
- package/docs/functions/readFilenamesRecursiveSync.md +7 -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 +18 -2
- 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 +4 -4
- package/docs/functions/sanitizeFilepath.md +4 -4
- 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 +21 -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/globals.md +0 -23
- 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 +11 -11
- package/docs/interfaces/BaseFuncItem.md +10 -10
- 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 +13 -13
- 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 +11 -11
- 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 +13 -13
- 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 +14 -14
- 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/FuncParamType.md +1 -1
- package/docs/type-aliases/PromptExamples.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/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/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 +2 -2
- 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 +5 -3
- package/dist/chunk-YVFGQB4L.mjs +0 -1
- package/docs/classes/HFEnvironment.md +0 -184
- package/docs/classes/HFInterpreter.md +0 -77
- package/docs/classes/HFTemplate.md +0 -67
- package/docs/classes/HfPromptTemplate.md +0 -1158
- package/docs/functions/filenameReservedRegex.md +0 -20
- package/docs/functions/hfParse.md +0 -24
- package/docs/functions/hfTokenize.md +0 -27
- package/docs/functions/interpolateEnv.md +0 -29
- package/docs/functions/interpolateFString.md +0 -29
- package/docs/functions/interpolateGolangTemplate.md +0 -35
- package/docs/functions/parseFString.md +0 -26
- package/docs/functions/reControlCharsRegex.md +0 -19
- package/docs/interfaces/DotenvExpandOptions.md +0 -43
- package/docs/interfaces/DotenvExpandOutput.md +0 -25
- package/docs/interfaces/DotenvParseInput.md +0 -13
- package/docs/interfaces/DotenvParseOutput.md +0 -13
- package/docs/interfaces/DotenvPopulateInput.md +0 -13
- package/docs/type-aliases/FStringPromptTemplateNode.md +0 -14
- package/docs/type-aliases/PromptTemplateType.md +0 -11
- package/docs/type-aliases/PromptType.md +0 -11
- package/docs/variables/HFBuiltins.md +0 -122
- package/docs/variables/PromptTemplateTypes.md +0 -11
- package/docs/variables/PromptTypes.md +0 -14
|
@@ -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/b0ee9498dddfa5222989cf00502bb34c601df743/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:225](https://github.com/isdk/ai-tool.js/blob/
|
|
25
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:225](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L225)
|
|
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/b0ee9498dddfa5222989cf00502bb34c601df743/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` **alias**: `string` \| `string`[]
|
|
76
76
|
|
|
77
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:31](https://github.com/isdk/ai-tool.js/blob/
|
|
77
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:31](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L31)
|
|
78
78
|
|
|
79
79
|
#### Inherited from
|
|
80
80
|
|
|
@@ -86,7 +86,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:31](https://github.com/isdk/ai-to
|
|
|
86
86
|
|
|
87
87
|
> `optional` **allowExportFunc**: `boolean`
|
|
88
88
|
|
|
89
|
-
Defined in: [packages/ai-tool/src/server-tools.ts:14](https://github.com/isdk/ai-tool.js/blob/
|
|
89
|
+
Defined in: [packages/ai-tool/src/server-tools.ts:14](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/server-tools.ts#L14)
|
|
90
90
|
|
|
91
91
|
#### Inherited from
|
|
92
92
|
|
|
@@ -98,7 +98,7 @@ Defined in: [packages/ai-tool/src/server-tools.ts:14](https://github.com/isdk/ai
|
|
|
98
98
|
|
|
99
99
|
> `optional` **apiRoot**: `string`
|
|
100
100
|
|
|
101
|
-
Defined in: [packages/ai-tool/src/utils/consts.ts:34](https://github.com/isdk/ai-tool.js/blob/
|
|
101
|
+
Defined in: [packages/ai-tool/src/utils/consts.ts:34](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/consts.ts#L34)
|
|
102
102
|
|
|
103
103
|
#### Inherited from
|
|
104
104
|
|
|
@@ -142,7 +142,7 @@ The default options for export and assign
|
|
|
142
142
|
|
|
143
143
|
> `optional` **fetchOptions**: `any`
|
|
144
144
|
|
|
145
|
-
Defined in: [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai-tool.js/blob/
|
|
145
|
+
Defined in: [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/consts.ts#L36)
|
|
146
146
|
|
|
147
147
|
#### Inherited from
|
|
148
148
|
|
|
@@ -154,7 +154,7 @@ Defined in: [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai
|
|
|
154
154
|
|
|
155
155
|
> `optional` **isApi**: `boolean`
|
|
156
156
|
|
|
157
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-tool.js/blob/
|
|
157
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L29)
|
|
158
158
|
|
|
159
159
|
#### Inherited from
|
|
160
160
|
|
|
@@ -166,7 +166,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-to
|
|
|
166
166
|
|
|
167
167
|
> `optional` **name**: `string`
|
|
168
168
|
|
|
169
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/
|
|
169
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L23)
|
|
170
170
|
|
|
171
171
|
#### Inherited from
|
|
172
172
|
|
|
@@ -192,7 +192,7 @@ the property with the default prefix '$' will not be exported.
|
|
|
192
192
|
|
|
193
193
|
> `optional` **params**: [`FuncParams`](../interfaces/FuncParams.md) \| [`FuncParam`](../interfaces/FuncParam.md)[]
|
|
194
194
|
|
|
195
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/
|
|
195
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L24)
|
|
196
196
|
|
|
197
197
|
#### Inherited from
|
|
198
198
|
|
|
@@ -204,7 +204,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-to
|
|
|
204
204
|
|
|
205
205
|
> `optional` **result**: `string`
|
|
206
206
|
|
|
207
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-tool.js/blob/
|
|
207
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L25)
|
|
208
208
|
|
|
209
209
|
#### Inherited from
|
|
210
210
|
|
|
@@ -216,7 +216,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-to
|
|
|
216
216
|
|
|
217
217
|
> `optional` **scope**: `any`
|
|
218
218
|
|
|
219
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/
|
|
219
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L26)
|
|
220
220
|
|
|
221
221
|
#### Inherited from
|
|
222
222
|
|
|
@@ -228,7 +228,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-to
|
|
|
228
228
|
|
|
229
229
|
> `optional` **setup**: (`this`, `options`?) => `void`
|
|
230
230
|
|
|
231
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-tool.js/blob/
|
|
231
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L28)
|
|
232
232
|
|
|
233
233
|
#### Parameters
|
|
234
234
|
|
|
@@ -254,7 +254,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-to
|
|
|
254
254
|
|
|
255
255
|
> `optional` **stream**: `boolean`
|
|
256
256
|
|
|
257
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-tool.js/blob/
|
|
257
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L30)
|
|
258
258
|
|
|
259
259
|
#### Inherited from
|
|
260
260
|
|
|
@@ -266,7 +266,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-to
|
|
|
266
266
|
|
|
267
267
|
> `optional` **tags**: `string` \| `string`[]
|
|
268
268
|
|
|
269
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-tool.js/blob/
|
|
269
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L27)
|
|
270
270
|
|
|
271
271
|
#### Inherited from
|
|
272
272
|
|
|
@@ -278,7 +278,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-to
|
|
|
278
278
|
|
|
279
279
|
> `static` **aliases**: `object` = `{}`
|
|
280
280
|
|
|
281
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:58](https://github.com/isdk/ai-tool.js/blob/
|
|
281
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:58](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L58)
|
|
282
282
|
|
|
283
283
|
#### Index Signature
|
|
284
284
|
|
|
@@ -294,7 +294,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:58](https://github.com/isdk/ai-to
|
|
|
294
294
|
|
|
295
295
|
> `static` **dataPath**: `string`
|
|
296
296
|
|
|
297
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:59](https://github.com/isdk/ai-tool.js/blob/
|
|
297
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:59](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L59)
|
|
298
298
|
|
|
299
299
|
#### Inherited from
|
|
300
300
|
|
|
@@ -306,7 +306,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:59](https://github.com/isdk/ai-to
|
|
|
306
306
|
|
|
307
307
|
> `static` **items**: [`Funcs`](../interfaces/Funcs.md) = `{}`
|
|
308
308
|
|
|
309
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:57](https://github.com/isdk/ai-tool.js/blob/
|
|
309
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:57](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L57)
|
|
310
310
|
|
|
311
311
|
#### Inherited from
|
|
312
312
|
|
|
@@ -320,7 +320,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:57](https://github.com/isdk/ai-to
|
|
|
320
320
|
|
|
321
321
|
> **get** `static` **apiRoot**(): `undefined` \| `string`
|
|
322
322
|
|
|
323
|
-
Defined in: [packages/ai-tool/src/server-tools.ts:26](https://github.com/isdk/ai-tool.js/blob/
|
|
323
|
+
Defined in: [packages/ai-tool/src/server-tools.ts:26](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/server-tools.ts#L26)
|
|
324
324
|
|
|
325
325
|
##### Returns
|
|
326
326
|
|
|
@@ -336,7 +336,7 @@ Defined in: [packages/ai-tool/src/server-tools.ts:26](https://github.com/isdk/ai
|
|
|
336
336
|
|
|
337
337
|
> **arr2ObjParams**(`params`): `any`[]
|
|
338
338
|
|
|
339
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:269](https://github.com/isdk/ai-tool.js/blob/
|
|
339
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:269](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L269)
|
|
340
340
|
|
|
341
341
|
#### Parameters
|
|
342
342
|
|
|
@@ -640,7 +640,7 @@ the dest object.
|
|
|
640
640
|
|
|
641
641
|
> **func**(`__namedParameters`): `any`
|
|
642
642
|
|
|
643
|
-
Defined in: [packages/ai-tool/src/server-tools.ts:59](https://github.com/isdk/ai-tool.js/blob/
|
|
643
|
+
Defined in: [packages/ai-tool/src/server-tools.ts:59](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/server-tools.ts#L59)
|
|
644
644
|
|
|
645
645
|
#### Parameters
|
|
646
646
|
|
|
@@ -660,7 +660,7 @@ Defined in: [packages/ai-tool/src/server-tools.ts:59](https://github.com/isdk/ai
|
|
|
660
660
|
|
|
661
661
|
> **getFunc**(`name`?): `any`
|
|
662
662
|
|
|
663
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:322](https://github.com/isdk/ai-tool.js/blob/
|
|
663
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:322](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L322)
|
|
664
664
|
|
|
665
665
|
#### Parameters
|
|
666
666
|
|
|
@@ -682,7 +682,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:322](https://github.com/isdk/ai-t
|
|
|
682
682
|
|
|
683
683
|
> **getFuncWithPos**(`name`?): `any`
|
|
684
684
|
|
|
685
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:346](https://github.com/isdk/ai-tool.js/blob/
|
|
685
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:346](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L346)
|
|
686
686
|
|
|
687
687
|
#### Parameters
|
|
688
688
|
|
|
@@ -724,7 +724,7 @@ the descriptors of properties object
|
|
|
724
724
|
|
|
725
725
|
> **hasAsyncFeature**(`feature`): `boolean`
|
|
726
726
|
|
|
727
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:351](https://github.com/isdk/ai-tool.js/blob/
|
|
727
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:351](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L351)
|
|
728
728
|
|
|
729
729
|
#### Parameters
|
|
730
730
|
|
|
@@ -854,7 +854,7 @@ The source object
|
|
|
854
854
|
|
|
855
855
|
> **isStream**(`params`): `undefined` \| `boolean`
|
|
856
856
|
|
|
857
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:357](https://github.com/isdk/ai-tool.js/blob/
|
|
857
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:357](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L357)
|
|
858
858
|
|
|
859
859
|
#### Parameters
|
|
860
860
|
|
|
@@ -908,7 +908,7 @@ the dest object.
|
|
|
908
908
|
|
|
909
909
|
> **obj2ArrParams**(`params`?): `any`[]
|
|
910
910
|
|
|
911
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:282](https://github.com/isdk/ai-tool.js/blob/
|
|
911
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:282](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L282)
|
|
912
912
|
|
|
913
913
|
#### Parameters
|
|
914
914
|
|
|
@@ -956,7 +956,7 @@ A property name.
|
|
|
956
956
|
|
|
957
957
|
> **register**(): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
958
958
|
|
|
959
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:252](https://github.com/isdk/ai-tool.js/blob/
|
|
959
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:252](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L252)
|
|
960
960
|
|
|
961
961
|
#### Returns
|
|
962
962
|
|
|
@@ -972,7 +972,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:252](https://github.com/isdk/ai-t
|
|
|
972
972
|
|
|
973
973
|
> **run**(`params`?): `Promise`\<`any`\>
|
|
974
974
|
|
|
975
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:309](https://github.com/isdk/ai-tool.js/blob/
|
|
975
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:309](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L309)
|
|
976
976
|
|
|
977
977
|
#### Parameters
|
|
978
978
|
|
|
@@ -994,7 +994,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:309](https://github.com/isdk/ai-t
|
|
|
994
994
|
|
|
995
995
|
> **runAs**(`name`, `params`?): `Promise`\<`any`\>
|
|
996
996
|
|
|
997
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:313](https://github.com/isdk/ai-tool.js/blob/
|
|
997
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:313](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L313)
|
|
998
998
|
|
|
999
999
|
#### Parameters
|
|
1000
1000
|
|
|
@@ -1020,7 +1020,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:313](https://github.com/isdk/ai-t
|
|
|
1020
1020
|
|
|
1021
1021
|
> **runAsSync**(`name`, `params`?): `any`
|
|
1022
1022
|
|
|
1023
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:317](https://github.com/isdk/ai-tool.js/blob/
|
|
1023
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:317](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L317)
|
|
1024
1024
|
|
|
1025
1025
|
#### Parameters
|
|
1026
1026
|
|
|
@@ -1046,7 +1046,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:317](https://github.com/isdk/ai-t
|
|
|
1046
1046
|
|
|
1047
1047
|
> **runSync**(`params`?): `any`
|
|
1048
1048
|
|
|
1049
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:295](https://github.com/isdk/ai-tool.js/blob/
|
|
1049
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:295](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L295)
|
|
1050
1050
|
|
|
1051
1051
|
#### Parameters
|
|
1052
1052
|
|
|
@@ -1068,7 +1068,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:295](https://github.com/isdk/ai-t
|
|
|
1068
1068
|
|
|
1069
1069
|
> **runWithPos**(...`params`): `Promise`\<`any`\>
|
|
1070
1070
|
|
|
1071
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:338](https://github.com/isdk/ai-tool.js/blob/
|
|
1071
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:338](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L338)
|
|
1072
1072
|
|
|
1073
1073
|
#### Parameters
|
|
1074
1074
|
|
|
@@ -1090,7 +1090,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:338](https://github.com/isdk/ai-t
|
|
|
1090
1090
|
|
|
1091
1091
|
> **runWithPosAs**(`name`, ...`params`): `Promise`\<`any`\>
|
|
1092
1092
|
|
|
1093
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:342](https://github.com/isdk/ai-tool.js/blob/
|
|
1093
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:342](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L342)
|
|
1094
1094
|
|
|
1095
1095
|
#### Parameters
|
|
1096
1096
|
|
|
@@ -1116,7 +1116,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:342](https://github.com/isdk/ai-t
|
|
|
1116
1116
|
|
|
1117
1117
|
> **runWithPosAsSync**(`name`, ...`params`): `any`
|
|
1118
1118
|
|
|
1119
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:334](https://github.com/isdk/ai-tool.js/blob/
|
|
1119
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:334](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L334)
|
|
1120
1120
|
|
|
1121
1121
|
#### Parameters
|
|
1122
1122
|
|
|
@@ -1142,7 +1142,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:334](https://github.com/isdk/ai-t
|
|
|
1142
1142
|
|
|
1143
1143
|
> **runWithPosSync**(...`params`): `any`
|
|
1144
1144
|
|
|
1145
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:327](https://github.com/isdk/ai-tool.js/blob/
|
|
1145
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:327](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L327)
|
|
1146
1146
|
|
|
1147
1147
|
#### Parameters
|
|
1148
1148
|
|
|
@@ -1242,7 +1242,7 @@ Returns a string representation of an object.
|
|
|
1242
1242
|
|
|
1243
1243
|
> **unregister**(): `any`
|
|
1244
1244
|
|
|
1245
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:265](https://github.com/isdk/ai-tool.js/blob/
|
|
1245
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:265](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L265)
|
|
1246
1246
|
|
|
1247
1247
|
#### Returns
|
|
1248
1248
|
|
|
@@ -1778,7 +1778,7 @@ An iterable object that contains key-value entries for properties and methods.
|
|
|
1778
1778
|
|
|
1779
1779
|
> `static` **get**(`name`): [`ToolFunc`](ToolFunc.md)
|
|
1780
1780
|
|
|
1781
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:61](https://github.com/isdk/ai-tool.js/blob/
|
|
1781
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:61](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L61)
|
|
1782
1782
|
|
|
1783
1783
|
#### Parameters
|
|
1784
1784
|
|
|
@@ -1800,7 +1800,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:61](https://github.com/isdk/ai-to
|
|
|
1800
1800
|
|
|
1801
1801
|
> `static` **getAllByTag**(`tagName`): [`ToolFunc`](ToolFunc.md)[]
|
|
1802
1802
|
|
|
1803
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:93](https://github.com/isdk/ai-tool.js/blob/
|
|
1803
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:93](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L93)
|
|
1804
1804
|
|
|
1805
1805
|
#### Parameters
|
|
1806
1806
|
|
|
@@ -1822,7 +1822,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:93](https://github.com/isdk/ai-to
|
|
|
1822
1822
|
|
|
1823
1823
|
> `static` **getByTag**(`tagName`): `undefined` \| [`ToolFunc`](ToolFunc.md)
|
|
1824
1824
|
|
|
1825
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:73](https://github.com/isdk/ai-tool.js/blob/
|
|
1825
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:73](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L73)
|
|
1826
1826
|
|
|
1827
1827
|
#### Parameters
|
|
1828
1828
|
|
|
@@ -1844,7 +1844,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:73](https://github.com/isdk/ai-to
|
|
|
1844
1844
|
|
|
1845
1845
|
> `static` **getFunc**(`name`): `any`
|
|
1846
1846
|
|
|
1847
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:134](https://github.com/isdk/ai-tool.js/blob/
|
|
1847
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:134](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L134)
|
|
1848
1848
|
|
|
1849
1849
|
#### Parameters
|
|
1850
1850
|
|
|
@@ -1866,7 +1866,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:134](https://github.com/isdk/ai-t
|
|
|
1866
1866
|
|
|
1867
1867
|
> `static` **getFuncWithPos**(`name`): `any`
|
|
1868
1868
|
|
|
1869
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:155](https://github.com/isdk/ai-tool.js/blob/
|
|
1869
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:155](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L155)
|
|
1870
1870
|
|
|
1871
1871
|
#### Parameters
|
|
1872
1872
|
|
|
@@ -2048,7 +2048,7 @@ The object that references the prototype.
|
|
|
2048
2048
|
|
|
2049
2049
|
> `static` **hasAsyncFeature**(`feature`): `boolean`
|
|
2050
2050
|
|
|
2051
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:111](https://github.com/isdk/ai-tool.js/blob/
|
|
2051
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:111](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L111)
|
|
2052
2052
|
|
|
2053
2053
|
#### Parameters
|
|
2054
2054
|
|
|
@@ -2262,7 +2262,7 @@ Object that contains the properties and methods. This can be an object that you
|
|
|
2262
2262
|
|
|
2263
2263
|
> `static` **list**(): [`Funcs`](../interfaces/Funcs.md)
|
|
2264
2264
|
|
|
2265
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:69](https://github.com/isdk/ai-tool.js/blob/
|
|
2265
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:69](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L69)
|
|
2266
2266
|
|
|
2267
2267
|
#### Returns
|
|
2268
2268
|
|
|
@@ -2310,7 +2310,7 @@ Object to make non-extensible.
|
|
|
2310
2310
|
|
|
2311
2311
|
> `static` **register**(`name`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2312
2312
|
|
|
2313
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:160](https://github.com/isdk/ai-tool.js/blob/
|
|
2313
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:160](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L160)
|
|
2314
2314
|
|
|
2315
2315
|
##### Parameters
|
|
2316
2316
|
|
|
@@ -2334,7 +2334,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:160](https://github.com/isdk/ai-t
|
|
|
2334
2334
|
|
|
2335
2335
|
> `static` **register**(`func`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2336
2336
|
|
|
2337
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:161](https://github.com/isdk/ai-tool.js/blob/
|
|
2337
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:161](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L161)
|
|
2338
2338
|
|
|
2339
2339
|
##### Parameters
|
|
2340
2340
|
|
|
@@ -2358,7 +2358,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:161](https://github.com/isdk/ai-t
|
|
|
2358
2358
|
|
|
2359
2359
|
> `static` **register**(`name`, `options`?): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2360
2360
|
|
|
2361
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:162](https://github.com/isdk/ai-tool.js/blob/
|
|
2361
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:162](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L162)
|
|
2362
2362
|
|
|
2363
2363
|
##### Parameters
|
|
2364
2364
|
|
|
@@ -2384,7 +2384,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:162](https://github.com/isdk/ai-t
|
|
|
2384
2384
|
|
|
2385
2385
|
> `static` **run**(`name`, `params`?): `Promise`\<`any`\>
|
|
2386
2386
|
|
|
2387
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:118](https://github.com/isdk/ai-tool.js/blob/
|
|
2387
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:118](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L118)
|
|
2388
2388
|
|
|
2389
2389
|
#### Parameters
|
|
2390
2390
|
|
|
@@ -2410,7 +2410,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:118](https://github.com/isdk/ai-t
|
|
|
2410
2410
|
|
|
2411
2411
|
> `static` **runSync**(`name`, `params`?): `any`
|
|
2412
2412
|
|
|
2413
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:126](https://github.com/isdk/ai-tool.js/blob/
|
|
2413
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:126](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L126)
|
|
2414
2414
|
|
|
2415
2415
|
#### Parameters
|
|
2416
2416
|
|
|
@@ -2436,7 +2436,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:126](https://github.com/isdk/ai-t
|
|
|
2436
2436
|
|
|
2437
2437
|
> `static` **runWithPos**(`name`, ...`params`): `Promise`\<`any`\>
|
|
2438
2438
|
|
|
2439
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:139](https://github.com/isdk/ai-tool.js/blob/
|
|
2439
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:139](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L139)
|
|
2440
2440
|
|
|
2441
2441
|
#### Parameters
|
|
2442
2442
|
|
|
@@ -2462,7 +2462,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:139](https://github.com/isdk/ai-t
|
|
|
2462
2462
|
|
|
2463
2463
|
> `static` **runWithPosSync**(`name`, ...`params`): `any`
|
|
2464
2464
|
|
|
2465
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:147](https://github.com/isdk/ai-tool.js/blob/
|
|
2465
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:147](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L147)
|
|
2466
2466
|
|
|
2467
2467
|
#### Parameters
|
|
2468
2468
|
|
|
@@ -2518,7 +2518,7 @@ Object on which to lock the attributes.
|
|
|
2518
2518
|
|
|
2519
2519
|
> `static` **setApiRoot**(`v`): `void`
|
|
2520
2520
|
|
|
2521
|
-
Defined in: [packages/ai-tool/src/server-tools.ts:30](https://github.com/isdk/ai-tool.js/blob/
|
|
2521
|
+
Defined in: [packages/ai-tool/src/server-tools.ts:30](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/server-tools.ts#L30)
|
|
2522
2522
|
|
|
2523
2523
|
#### Parameters
|
|
2524
2524
|
|
|
@@ -2568,7 +2568,7 @@ The value of the new prototype or null.
|
|
|
2568
2568
|
|
|
2569
2569
|
> `static` **toJSON**(): `object`
|
|
2570
2570
|
|
|
2571
|
-
Defined in: [packages/ai-tool/src/server-tools.ts:44](https://github.com/isdk/ai-tool.js/blob/
|
|
2571
|
+
Defined in: [packages/ai-tool/src/server-tools.ts:44](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/server-tools.ts#L44)
|
|
2572
2572
|
|
|
2573
2573
|
#### Returns
|
|
2574
2574
|
|
|
@@ -2580,7 +2580,7 @@ Defined in: [packages/ai-tool/src/server-tools.ts:44](https://github.com/isdk/ai
|
|
|
2580
2580
|
|
|
2581
2581
|
> `static` **unregister**(`name`): `undefined` \| [`ToolFunc`](ToolFunc.md)
|
|
2582
2582
|
|
|
2583
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:207](https://github.com/isdk/ai-tool.js/blob/
|
|
2583
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:207](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L207)
|
|
2584
2584
|
|
|
2585
2585
|
#### Parameters
|
|
2586
2586
|
|
|
@@ -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/b0ee9498dddfa5222989cf00502bb34c601df743/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/b0ee9498dddfa5222989cf00502bb34c601df743/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/b0ee9498dddfa5222989cf00502bb34c601df743/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/b0ee9498dddfa5222989cf00502bb34c601df743/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/b0ee9498dddfa5222989cf00502bb34c601df743/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/b0ee9498dddfa5222989cf00502bb34c601df743/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/b0ee9498dddfa5222989cf00502bb34c601df743/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/b0ee9498dddfa5222989cf00502bb34c601df743/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/b0ee9498dddfa5222989cf00502bb34c601df743/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/b0ee9498dddfa5222989cf00502bb34c601df743/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/b0ee9498dddfa5222989cf00502bb34c601df743/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/b0ee9498dddfa5222989cf00502bb34c601df743/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/b0ee9498dddfa5222989cf00502bb34c601df743/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/b0ee9498dddfa5222989cf00502bb34c601df743/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/b0ee9498dddfa5222989cf00502bb34c601df743/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/b0ee9498dddfa5222989cf00502bb34c601df743/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/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/cancelable-ability.ts#L55)
|
|
122
122
|
|
|
123
123
|
#### Parameters
|
|
124
124
|
|