@isdk/ai-tool 0.5.5 → 0.5.7
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-VIG2GB47.mjs +1 -39
- package/dist/chunk-XLXW6OPN.mjs +1 -0
- package/dist/funcs.d.mts +1 -1
- package/dist/funcs.d.ts +1 -1
- package/dist/funcs.js +1 -5156
- package/dist/funcs.mjs +1 -29
- package/dist/{index-Br-4ZYgE.d.mts → index-BkwhCK1q.d.mts} +7 -0
- package/dist/{index-Br-4ZYgE.d.ts → index-BkwhCK1q.d.ts} +7 -0
- package/dist/index.d.mts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +1 -8132
- package/dist/index.mjs +1 -476
- package/dist/test/util.js +1 -101
- package/dist/test/util.mjs +1 -30
- package/docs/classes/BinarySemaphore.md +25 -25
- package/docs/classes/CancelableAbility.md +25 -25
- package/docs/classes/ClientTools.md +83 -55
- package/docs/classes/EnvPromptTemplate.md +19 -19
- package/docs/classes/EventClient.md +106 -78
- package/docs/classes/EventServer.md +107 -79
- package/docs/classes/EventToolFunc.md +75 -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 +82 -62
- package/docs/classes/ResServerTools.md +83 -63
- package/docs/classes/SSEChannel.md +16 -16
- package/docs/classes/Semaphore.md +26 -26
- package/docs/classes/ServerTools.md +79 -51
- package/docs/classes/SignalGate.md +9 -9
- package/docs/classes/TaskAbortController.md +8 -8
- package/docs/classes/ToolFunc.md +68 -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 +22 -10
- package/docs/interfaces/BaseFuncItem.md +17 -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 +24 -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 +22 -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 +24 -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 +25 -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 +9 -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
- package/dist/chunk-VJ45JQBR.mjs +0 -7829
|
@@ -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/077730e62e6c723611b64a587e36b69766741af4/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:
|
|
25
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:225](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/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/077730e62e6c723611b64a587e36b69766741af4/src/utils/consts.ts#L35)
|
|
66
66
|
|
|
67
67
|
#### Inherited from
|
|
68
68
|
|
|
@@ -70,11 +70,23 @@ Defined in: [packages/ai-tool/src/utils/consts.ts:35](https://github.com/isdk/ai
|
|
|
70
70
|
|
|
71
71
|
***
|
|
72
72
|
|
|
73
|
+
### alias?
|
|
74
|
+
|
|
75
|
+
> `optional` **alias**: `string` \| `string`[]
|
|
76
|
+
|
|
77
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:31](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L31)
|
|
78
|
+
|
|
79
|
+
#### Inherited from
|
|
80
|
+
|
|
81
|
+
[`ToolFunc`](ToolFunc.md).[`alias`](ToolFunc.md#alias)
|
|
82
|
+
|
|
83
|
+
***
|
|
84
|
+
|
|
73
85
|
### allowExportFunc?
|
|
74
86
|
|
|
75
87
|
> `optional` **allowExportFunc**: `boolean`
|
|
76
88
|
|
|
77
|
-
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/077730e62e6c723611b64a587e36b69766741af4/src/server-tools.ts#L14)
|
|
78
90
|
|
|
79
91
|
#### Inherited from
|
|
80
92
|
|
|
@@ -86,7 +98,7 @@ Defined in: [packages/ai-tool/src/server-tools.ts:14](https://github.com/isdk/ai
|
|
|
86
98
|
|
|
87
99
|
> `optional` **apiRoot**: `string`
|
|
88
100
|
|
|
89
|
-
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/077730e62e6c723611b64a587e36b69766741af4/src/utils/consts.ts#L34)
|
|
90
102
|
|
|
91
103
|
#### Inherited from
|
|
92
104
|
|
|
@@ -130,7 +142,7 @@ The default options for export and assign
|
|
|
130
142
|
|
|
131
143
|
> `optional` **fetchOptions**: `any`
|
|
132
144
|
|
|
133
|
-
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/077730e62e6c723611b64a587e36b69766741af4/src/utils/consts.ts#L36)
|
|
134
146
|
|
|
135
147
|
#### Inherited from
|
|
136
148
|
|
|
@@ -142,7 +154,7 @@ Defined in: [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai
|
|
|
142
154
|
|
|
143
155
|
> `optional` **isApi**: `boolean`
|
|
144
156
|
|
|
145
|
-
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/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L29)
|
|
146
158
|
|
|
147
159
|
#### Inherited from
|
|
148
160
|
|
|
@@ -154,7 +166,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-to
|
|
|
154
166
|
|
|
155
167
|
> `optional` **name**: `string`
|
|
156
168
|
|
|
157
|
-
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/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L23)
|
|
158
170
|
|
|
159
171
|
#### Inherited from
|
|
160
172
|
|
|
@@ -180,7 +192,7 @@ the property with the default prefix '$' will not be exported.
|
|
|
180
192
|
|
|
181
193
|
> `optional` **params**: [`FuncParams`](../interfaces/FuncParams.md) \| [`FuncParam`](../interfaces/FuncParam.md)[]
|
|
182
194
|
|
|
183
|
-
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/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L24)
|
|
184
196
|
|
|
185
197
|
#### Inherited from
|
|
186
198
|
|
|
@@ -192,7 +204,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-to
|
|
|
192
204
|
|
|
193
205
|
> `optional` **result**: `string`
|
|
194
206
|
|
|
195
|
-
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/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L25)
|
|
196
208
|
|
|
197
209
|
#### Inherited from
|
|
198
210
|
|
|
@@ -204,7 +216,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-to
|
|
|
204
216
|
|
|
205
217
|
> `optional` **scope**: `any`
|
|
206
218
|
|
|
207
|
-
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/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L26)
|
|
208
220
|
|
|
209
221
|
#### Inherited from
|
|
210
222
|
|
|
@@ -216,7 +228,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-to
|
|
|
216
228
|
|
|
217
229
|
> `optional` **setup**: (`this`, `options`?) => `void`
|
|
218
230
|
|
|
219
|
-
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/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L28)
|
|
220
232
|
|
|
221
233
|
#### Parameters
|
|
222
234
|
|
|
@@ -242,7 +254,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-to
|
|
|
242
254
|
|
|
243
255
|
> `optional` **stream**: `boolean`
|
|
244
256
|
|
|
245
|
-
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/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L30)
|
|
246
258
|
|
|
247
259
|
#### Inherited from
|
|
248
260
|
|
|
@@ -254,7 +266,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-to
|
|
|
254
266
|
|
|
255
267
|
> `optional` **tags**: `string` \| `string`[]
|
|
256
268
|
|
|
257
|
-
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/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L27)
|
|
258
270
|
|
|
259
271
|
#### Inherited from
|
|
260
272
|
|
|
@@ -262,11 +274,27 @@ Defined in: [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-to
|
|
|
262
274
|
|
|
263
275
|
***
|
|
264
276
|
|
|
277
|
+
### aliases
|
|
278
|
+
|
|
279
|
+
> `static` **aliases**: `object` = `{}`
|
|
280
|
+
|
|
281
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:58](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L58)
|
|
282
|
+
|
|
283
|
+
#### Index Signature
|
|
284
|
+
|
|
285
|
+
\[`name`: `string`\]: `string`
|
|
286
|
+
|
|
287
|
+
#### Inherited from
|
|
288
|
+
|
|
289
|
+
[`ToolFunc`](ToolFunc.md).[`aliases`](ToolFunc.md#aliases)
|
|
290
|
+
|
|
291
|
+
***
|
|
292
|
+
|
|
265
293
|
### dataPath
|
|
266
294
|
|
|
267
295
|
> `static` **dataPath**: `string`
|
|
268
296
|
|
|
269
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
297
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:59](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L59)
|
|
270
298
|
|
|
271
299
|
#### Inherited from
|
|
272
300
|
|
|
@@ -278,7 +306,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:57](https://github.com/isdk/ai-to
|
|
|
278
306
|
|
|
279
307
|
> `static` **items**: [`Funcs`](../interfaces/Funcs.md) = `{}`
|
|
280
308
|
|
|
281
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
309
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:57](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L57)
|
|
282
310
|
|
|
283
311
|
#### Inherited from
|
|
284
312
|
|
|
@@ -292,7 +320,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:56](https://github.com/isdk/ai-to
|
|
|
292
320
|
|
|
293
321
|
> **get** `static` **apiRoot**(): `undefined` \| `string`
|
|
294
322
|
|
|
295
|
-
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/077730e62e6c723611b64a587e36b69766741af4/src/server-tools.ts#L26)
|
|
296
324
|
|
|
297
325
|
##### Returns
|
|
298
326
|
|
|
@@ -308,7 +336,7 @@ Defined in: [packages/ai-tool/src/server-tools.ts:26](https://github.com/isdk/ai
|
|
|
308
336
|
|
|
309
337
|
> **arr2ObjParams**(`params`): `any`[]
|
|
310
338
|
|
|
311
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
339
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:269](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L269)
|
|
312
340
|
|
|
313
341
|
#### Parameters
|
|
314
342
|
|
|
@@ -612,7 +640,7 @@ the dest object.
|
|
|
612
640
|
|
|
613
641
|
> **func**(`__namedParameters`): `any`
|
|
614
642
|
|
|
615
|
-
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/077730e62e6c723611b64a587e36b69766741af4/src/server-tools.ts#L59)
|
|
616
644
|
|
|
617
645
|
#### Parameters
|
|
618
646
|
|
|
@@ -632,7 +660,7 @@ Defined in: [packages/ai-tool/src/server-tools.ts:59](https://github.com/isdk/ai
|
|
|
632
660
|
|
|
633
661
|
> **getFunc**(`name`?): `any`
|
|
634
662
|
|
|
635
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
663
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:322](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L322)
|
|
636
664
|
|
|
637
665
|
#### Parameters
|
|
638
666
|
|
|
@@ -654,7 +682,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:289](https://github.com/isdk/ai-t
|
|
|
654
682
|
|
|
655
683
|
> **getFuncWithPos**(`name`?): `any`
|
|
656
684
|
|
|
657
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
685
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:346](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L346)
|
|
658
686
|
|
|
659
687
|
#### Parameters
|
|
660
688
|
|
|
@@ -696,7 +724,7 @@ the descriptors of properties object
|
|
|
696
724
|
|
|
697
725
|
> **hasAsyncFeature**(`feature`): `boolean`
|
|
698
726
|
|
|
699
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
727
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:351](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L351)
|
|
700
728
|
|
|
701
729
|
#### Parameters
|
|
702
730
|
|
|
@@ -826,7 +854,7 @@ The source object
|
|
|
826
854
|
|
|
827
855
|
> **isStream**(`params`): `undefined` \| `boolean`
|
|
828
856
|
|
|
829
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
857
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:357](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L357)
|
|
830
858
|
|
|
831
859
|
#### Parameters
|
|
832
860
|
|
|
@@ -880,7 +908,7 @@ the dest object.
|
|
|
880
908
|
|
|
881
909
|
> **obj2ArrParams**(`params`?): `any`[]
|
|
882
910
|
|
|
883
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
911
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:282](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L282)
|
|
884
912
|
|
|
885
913
|
#### Parameters
|
|
886
914
|
|
|
@@ -928,7 +956,7 @@ A property name.
|
|
|
928
956
|
|
|
929
957
|
> **register**(): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
930
958
|
|
|
931
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
959
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:252](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L252)
|
|
932
960
|
|
|
933
961
|
#### Returns
|
|
934
962
|
|
|
@@ -944,7 +972,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:219](https://github.com/isdk/ai-t
|
|
|
944
972
|
|
|
945
973
|
> **run**(`params`?): `Promise`\<`any`\>
|
|
946
974
|
|
|
947
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
975
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:309](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L309)
|
|
948
976
|
|
|
949
977
|
#### Parameters
|
|
950
978
|
|
|
@@ -966,7 +994,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:276](https://github.com/isdk/ai-t
|
|
|
966
994
|
|
|
967
995
|
> **runAs**(`name`, `params`?): `Promise`\<`any`\>
|
|
968
996
|
|
|
969
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
997
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:313](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L313)
|
|
970
998
|
|
|
971
999
|
#### Parameters
|
|
972
1000
|
|
|
@@ -992,7 +1020,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:280](https://github.com/isdk/ai-t
|
|
|
992
1020
|
|
|
993
1021
|
> **runAsSync**(`name`, `params`?): `any`
|
|
994
1022
|
|
|
995
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1023
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:317](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L317)
|
|
996
1024
|
|
|
997
1025
|
#### Parameters
|
|
998
1026
|
|
|
@@ -1018,7 +1046,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:284](https://github.com/isdk/ai-t
|
|
|
1018
1046
|
|
|
1019
1047
|
> **runSync**(`params`?): `any`
|
|
1020
1048
|
|
|
1021
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1049
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:295](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L295)
|
|
1022
1050
|
|
|
1023
1051
|
#### Parameters
|
|
1024
1052
|
|
|
@@ -1040,7 +1068,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:262](https://github.com/isdk/ai-t
|
|
|
1040
1068
|
|
|
1041
1069
|
> **runWithPos**(...`params`): `Promise`\<`any`\>
|
|
1042
1070
|
|
|
1043
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1071
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:338](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L338)
|
|
1044
1072
|
|
|
1045
1073
|
#### Parameters
|
|
1046
1074
|
|
|
@@ -1062,7 +1090,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:305](https://github.com/isdk/ai-t
|
|
|
1062
1090
|
|
|
1063
1091
|
> **runWithPosAs**(`name`, ...`params`): `Promise`\<`any`\>
|
|
1064
1092
|
|
|
1065
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1093
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:342](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L342)
|
|
1066
1094
|
|
|
1067
1095
|
#### Parameters
|
|
1068
1096
|
|
|
@@ -1088,7 +1116,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:309](https://github.com/isdk/ai-t
|
|
|
1088
1116
|
|
|
1089
1117
|
> **runWithPosAsSync**(`name`, ...`params`): `any`
|
|
1090
1118
|
|
|
1091
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1119
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:334](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L334)
|
|
1092
1120
|
|
|
1093
1121
|
#### Parameters
|
|
1094
1122
|
|
|
@@ -1114,7 +1142,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:301](https://github.com/isdk/ai-t
|
|
|
1114
1142
|
|
|
1115
1143
|
> **runWithPosSync**(...`params`): `any`
|
|
1116
1144
|
|
|
1117
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1145
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:327](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L327)
|
|
1118
1146
|
|
|
1119
1147
|
#### Parameters
|
|
1120
1148
|
|
|
@@ -1214,7 +1242,7 @@ Returns a string representation of an object.
|
|
|
1214
1242
|
|
|
1215
1243
|
> **unregister**(): `any`
|
|
1216
1244
|
|
|
1217
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1245
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:265](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L265)
|
|
1218
1246
|
|
|
1219
1247
|
#### Returns
|
|
1220
1248
|
|
|
@@ -1750,7 +1778,7 @@ An iterable object that contains key-value entries for properties and methods.
|
|
|
1750
1778
|
|
|
1751
1779
|
> `static` **get**(`name`): [`ToolFunc`](ToolFunc.md)
|
|
1752
1780
|
|
|
1753
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1781
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:61](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L61)
|
|
1754
1782
|
|
|
1755
1783
|
#### Parameters
|
|
1756
1784
|
|
|
@@ -1772,7 +1800,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:59](https://github.com/isdk/ai-to
|
|
|
1772
1800
|
|
|
1773
1801
|
> `static` **getAllByTag**(`tagName`): [`ToolFunc`](ToolFunc.md)[]
|
|
1774
1802
|
|
|
1775
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1803
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:93](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L93)
|
|
1776
1804
|
|
|
1777
1805
|
#### Parameters
|
|
1778
1806
|
|
|
@@ -1794,7 +1822,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:87](https://github.com/isdk/ai-to
|
|
|
1794
1822
|
|
|
1795
1823
|
> `static` **getByTag**(`tagName`): `undefined` \| [`ToolFunc`](ToolFunc.md)
|
|
1796
1824
|
|
|
1797
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1825
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:73](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L73)
|
|
1798
1826
|
|
|
1799
1827
|
#### Parameters
|
|
1800
1828
|
|
|
@@ -1816,7 +1844,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:67](https://github.com/isdk/ai-to
|
|
|
1816
1844
|
|
|
1817
1845
|
> `static` **getFunc**(`name`): `any`
|
|
1818
1846
|
|
|
1819
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1847
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:134](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L134)
|
|
1820
1848
|
|
|
1821
1849
|
#### Parameters
|
|
1822
1850
|
|
|
@@ -1838,7 +1866,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:128](https://github.com/isdk/ai-t
|
|
|
1838
1866
|
|
|
1839
1867
|
> `static` **getFuncWithPos**(`name`): `any`
|
|
1840
1868
|
|
|
1841
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1869
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:155](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L155)
|
|
1842
1870
|
|
|
1843
1871
|
#### Parameters
|
|
1844
1872
|
|
|
@@ -2020,7 +2048,7 @@ The object that references the prototype.
|
|
|
2020
2048
|
|
|
2021
2049
|
> `static` **hasAsyncFeature**(`feature`): `boolean`
|
|
2022
2050
|
|
|
2023
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
2051
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:111](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L111)
|
|
2024
2052
|
|
|
2025
2053
|
#### Parameters
|
|
2026
2054
|
|
|
@@ -2234,7 +2262,7 @@ Object that contains the properties and methods. This can be an object that you
|
|
|
2234
2262
|
|
|
2235
2263
|
> `static` **list**(): [`Funcs`](../interfaces/Funcs.md)
|
|
2236
2264
|
|
|
2237
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
2265
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:69](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L69)
|
|
2238
2266
|
|
|
2239
2267
|
#### Returns
|
|
2240
2268
|
|
|
@@ -2282,7 +2310,7 @@ Object to make non-extensible.
|
|
|
2282
2310
|
|
|
2283
2311
|
> `static` **register**(`name`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2284
2312
|
|
|
2285
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
2313
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:160](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L160)
|
|
2286
2314
|
|
|
2287
2315
|
##### Parameters
|
|
2288
2316
|
|
|
@@ -2306,7 +2334,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:154](https://github.com/isdk/ai-t
|
|
|
2306
2334
|
|
|
2307
2335
|
> `static` **register**(`func`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2308
2336
|
|
|
2309
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
2337
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:161](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L161)
|
|
2310
2338
|
|
|
2311
2339
|
##### Parameters
|
|
2312
2340
|
|
|
@@ -2330,7 +2358,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:155](https://github.com/isdk/ai-t
|
|
|
2330
2358
|
|
|
2331
2359
|
> `static` **register**(`name`, `options`?): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2332
2360
|
|
|
2333
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
2361
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:162](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L162)
|
|
2334
2362
|
|
|
2335
2363
|
##### Parameters
|
|
2336
2364
|
|
|
@@ -2356,7 +2384,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:156](https://github.com/isdk/ai-t
|
|
|
2356
2384
|
|
|
2357
2385
|
> `static` **run**(`name`, `params`?): `Promise`\<`any`\>
|
|
2358
2386
|
|
|
2359
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
2387
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:118](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L118)
|
|
2360
2388
|
|
|
2361
2389
|
#### Parameters
|
|
2362
2390
|
|
|
@@ -2382,7 +2410,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:112](https://github.com/isdk/ai-t
|
|
|
2382
2410
|
|
|
2383
2411
|
> `static` **runSync**(`name`, `params`?): `any`
|
|
2384
2412
|
|
|
2385
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
2413
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:126](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L126)
|
|
2386
2414
|
|
|
2387
2415
|
#### Parameters
|
|
2388
2416
|
|
|
@@ -2408,7 +2436,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:120](https://github.com/isdk/ai-t
|
|
|
2408
2436
|
|
|
2409
2437
|
> `static` **runWithPos**(`name`, ...`params`): `Promise`\<`any`\>
|
|
2410
2438
|
|
|
2411
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
2439
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:139](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L139)
|
|
2412
2440
|
|
|
2413
2441
|
#### Parameters
|
|
2414
2442
|
|
|
@@ -2434,7 +2462,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:133](https://github.com/isdk/ai-t
|
|
|
2434
2462
|
|
|
2435
2463
|
> `static` **runWithPosSync**(`name`, ...`params`): `any`
|
|
2436
2464
|
|
|
2437
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
2465
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:147](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L147)
|
|
2438
2466
|
|
|
2439
2467
|
#### Parameters
|
|
2440
2468
|
|
|
@@ -2490,7 +2518,7 @@ Object on which to lock the attributes.
|
|
|
2490
2518
|
|
|
2491
2519
|
> `static` **setApiRoot**(`v`): `void`
|
|
2492
2520
|
|
|
2493
|
-
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/077730e62e6c723611b64a587e36b69766741af4/src/server-tools.ts#L30)
|
|
2494
2522
|
|
|
2495
2523
|
#### Parameters
|
|
2496
2524
|
|
|
@@ -2540,7 +2568,7 @@ The value of the new prototype or null.
|
|
|
2540
2568
|
|
|
2541
2569
|
> `static` **toJSON**(): `object`
|
|
2542
2570
|
|
|
2543
|
-
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/077730e62e6c723611b64a587e36b69766741af4/src/server-tools.ts#L44)
|
|
2544
2572
|
|
|
2545
2573
|
#### Returns
|
|
2546
2574
|
|
|
@@ -2552,7 +2580,7 @@ Defined in: [packages/ai-tool/src/server-tools.ts:44](https://github.com/isdk/ai
|
|
|
2552
2580
|
|
|
2553
2581
|
> `static` **unregister**(`name`): `undefined` \| [`ToolFunc`](ToolFunc.md)
|
|
2554
2582
|
|
|
2555
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
2583
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:207](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L207)
|
|
2556
2584
|
|
|
2557
2585
|
#### Parameters
|
|
2558
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/077730e62e6c723611b64a587e36b69766741af4/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/077730e62e6c723611b64a587e36b69766741af4/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/077730e62e6c723611b64a587e36b69766741af4/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/077730e62e6c723611b64a587e36b69766741af4/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/077730e62e6c723611b64a587e36b69766741af4/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/077730e62e6c723611b64a587e36b69766741af4/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/077730e62e6c723611b64a587e36b69766741af4/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/077730e62e6c723611b64a587e36b69766741af4/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/077730e62e6c723611b64a587e36b69766741af4/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/077730e62e6c723611b64a587e36b69766741af4/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/077730e62e6c723611b64a587e36b69766741af4/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/077730e62e6c723611b64a587e36b69766741af4/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/077730e62e6c723611b64a587e36b69766741af4/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/077730e62e6c723611b64a587e36b69766741af4/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/077730e62e6c723611b64a587e36b69766741af4/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/077730e62e6c723611b64a587e36b69766741af4/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/077730e62e6c723611b64a587e36b69766741af4/src/utils/cancelable-ability.ts#L55)
|
|
122
122
|
|
|
123
123
|
#### Parameters
|
|
124
124
|
|