@isdk/ai-tool 0.7.0 → 0.7.1
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-LNTIQQNN.mjs → chunk-4XRPAC7C.mjs} +1 -1
- package/dist/funcs.d.mts +1 -1
- package/dist/funcs.d.ts +1 -1
- package/dist/funcs.mjs +1 -1
- package/dist/{index-BCco-g_I.d.mts → index-DEUnmyUq.d.mts} +12 -1
- package/dist/{index-BCco-g_I.d.ts → index-DEUnmyUq.d.ts} +12 -1
- package/dist/index.d.mts +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/docs/api/classes/BinarySemaphore.md +25 -25
- package/docs/api/classes/CancelableAbility.md +25 -25
- package/docs/api/classes/ClientToolTransport.md +12 -12
- package/docs/api/classes/ClientTools.md +65 -61
- package/docs/api/classes/EventClient.md +105 -90
- package/docs/api/classes/EventServer.md +96 -88
- package/docs/api/classes/EventToolFunc.md +52 -52
- package/docs/api/classes/FewShotPromptTemplate.md +11 -11
- package/docs/api/classes/HttpClientToolTransport.md +13 -13
- package/docs/api/classes/HttpServerToolTransport.md +24 -16
- package/docs/api/classes/IntSet.md +12 -12
- package/docs/api/classes/PromptExampleSelector.md +9 -9
- package/docs/api/classes/ReadableStreamError.md +2 -2
- package/docs/api/classes/ResClientTools.md +560 -73
- package/docs/api/classes/ResServerTools.md +560 -74
- package/docs/api/classes/RpcMethodsClientTool.md +3275 -0
- package/docs/api/classes/RpcMethodsServerTool.md +3224 -0
- package/docs/api/classes/SSEChannel.md +16 -16
- package/docs/api/classes/Semaphore.md +26 -26
- package/docs/api/classes/ServerToolTransport.md +13 -13
- package/docs/api/classes/ServerTools.md +61 -57
- package/docs/api/classes/SignalGate.md +9 -9
- package/docs/api/classes/SseClientPubSubTransport.md +3 -3
- package/docs/api/classes/SseServerPubSubTransport.md +8 -8
- package/docs/api/classes/TaskAbortController.md +8 -8
- package/docs/api/classes/ToolFunc.md +50 -50
- package/docs/api/classes/ToolTransport.md +7 -7
- package/docs/api/classes/YamlTypeBaseObject.md +2 -2
- package/docs/api/enumerations/AsyncFeatureBits.md +4 -4
- package/docs/api/enumerations/AsyncFeatures.md +4 -4
- package/docs/api/enumerations/HashAlgorithm.md +12 -12
- package/docs/api/functions/AIArgProcessor.md +1 -1
- package/docs/api/functions/AIStream.md +1 -1
- package/docs/api/functions/ChoiceArgProcessor.md +1 -1
- package/docs/api/functions/DefaultDateFormat.md +1 -1
- package/docs/api/functions/ObjectArgsToArgsInfo.md +1 -1
- package/docs/api/functions/RateLimit.md +1 -1
- package/docs/api/functions/TemplateArgProcessor.md +1 -1
- package/docs/api/functions/assignDirs.md +1 -1
- package/docs/api/functions/backendEventable.md +1 -1
- package/docs/api/functions/beforeShutdown.md +1 -1
- package/docs/api/functions/calcPerplexity.md +1 -1
- package/docs/api/functions/calcPerplexitySimple.md +1 -1
- package/docs/api/functions/completeSentences.md +1 -1
- package/docs/api/functions/concatText.md +1 -1
- package/docs/api/functions/countLLMTokens.md +1 -1
- package/docs/api/functions/countRegexMatches.md +1 -1
- package/docs/api/functions/createCallbacksTransformer.md +1 -1
- package/docs/api/functions/createEmptyReadableStream.md +1 -1
- package/docs/api/functions/createEndWithRepetitionDetector.md +1 -1
- package/docs/api/functions/createEventStreamTransformer.md +1 -1
- package/docs/api/functions/createLRUCache.md +1 -1
- package/docs/api/functions/createYamlObjectTag.md +1 -1
- package/docs/api/functions/dateToText.md +1 -1
- package/docs/api/functions/decodeCharset.md +1 -1
- package/docs/api/functions/defaultsWithConcat.md +1 -1
- package/docs/api/functions/detectCharset.md +1 -1
- package/docs/api/functions/encodeLLMTokens.md +1 -1
- package/docs/api/functions/ensureQuoted.md +1 -1
- package/docs/api/functions/expandConfig.md +1 -1
- package/docs/api/functions/expandPath.md +1 -1
- package/docs/api/functions/expandPathInObject.md +1 -1
- package/docs/api/functions/expandPaths.md +1 -1
- package/docs/api/functions/fileIsExists.md +1 -1
- package/docs/api/functions/filterValidFnScope.md +1 -1
- package/docs/api/functions/findIndexNonEmptyFrom.md +1 -1
- package/docs/api/functions/findPort.md +1 -1
- package/docs/api/functions/formatTextWithSpace.md +1 -1
- package/docs/api/functions/funcGetMeta.md +1 -1
- package/docs/api/functions/funcWithMeta.md +1 -1
- package/docs/api/functions/genUrlParamsStr.md +1 -1
- package/docs/api/functions/getAllEnumKeys.md +1 -1
- package/docs/api/functions/getConfigFileNames.md +1 -1
- package/docs/api/functions/getConfigs.md +1 -1
- package/docs/api/functions/getFileMetaInfo.md +1 -1
- package/docs/api/functions/getHashAlgoBySize.md +1 -1
- package/docs/api/functions/getKeysPath.md +1 -1
- package/docs/api/functions/getLLMTokenizer.md +1 -1
- package/docs/api/functions/getPackageDir.md +1 -1
- package/docs/api/functions/getRealFilepath.md +1 -1
- package/docs/api/functions/getResponseErrorReadableStream.md +1 -1
- package/docs/api/functions/getXDGConfigs.md +1 -1
- package/docs/api/functions/hasDirectoryIn.md +1 -1
- package/docs/api/functions/hash.md +1 -1
- package/docs/api/functions/hashFile.md +1 -1
- package/docs/api/functions/hashObject.md +1 -1
- package/docs/api/functions/hashStream.md +1 -1
- package/docs/api/functions/initShutdown.md +1 -1
- package/docs/api/functions/isLangUsingSpaces.md +1 -1
- package/docs/api/functions/isListItemString.md +1 -1
- package/docs/api/functions/isModelNameMatched.md +1 -1
- package/docs/api/functions/isPunctuationChar.md +1 -1
- package/docs/api/functions/isQuoted.md +1 -1
- package/docs/api/functions/isRegExp.md +1 -1
- package/docs/api/functions/isSameString.md +1 -1
- package/docs/api/functions/isSectionString.md +1 -1
- package/docs/api/functions/isSentenceEnding.md +1 -1
- package/docs/api/functions/isSepLineString.md +1 -1
- package/docs/api/functions/isStrWrapped.md +1 -1
- package/docs/api/functions/isSubdirectory.md +1 -1
- package/docs/api/functions/isTitleString.md +1 -1
- package/docs/api/functions/isWebStream.md +1 -1
- package/docs/api/functions/joinSplitWords.md +1 -1
- package/docs/api/functions/jsonFilterToWhere.md +1 -1
- package/docs/api/functions/jsonToMarkdownStr.md +1 -1
- package/docs/api/functions/loadAIConfig.md +1 -1
- package/docs/api/functions/loadConfig.md +1 -1
- package/docs/api/functions/loadConfigFile.md +1 -1
- package/docs/api/functions/loadFileFromPaths.md +1 -1
- package/docs/api/functions/loadTextFromPaths.md +1 -1
- package/docs/api/functions/lrucache.md +1 -1
- package/docs/api/functions/makeToolFuncCancelable.md +1 -1
- package/docs/api/functions/matchUrlProtocol.md +1 -1
- package/docs/api/functions/memoize.md +1 -1
- package/docs/api/functions/mergeArray.md +1 -1
- package/docs/api/functions/messagesToText.md +1 -1
- package/docs/api/functions/normalizePath.md +1 -1
- package/docs/api/functions/paramsSizeToScaleStr.md +1 -1
- package/docs/api/functions/parseCommand.md +1 -1
- package/docs/api/functions/parseJsJson.md +1 -1
- package/docs/api/functions/parseJsJsonSimpleSync.md +1 -1
- package/docs/api/functions/parseObjectArgInfo.md +1 -1
- package/docs/api/functions/parseObjectArgumentInfos.md +1 -1
- package/docs/api/functions/parseObjectArguments.md +1 -1
- package/docs/api/functions/parseObjectArgumentsAsArgInfos.md +1 -1
- package/docs/api/functions/pruneSubdirectories.md +1 -1
- package/docs/api/functions/pruneSubdirectoriesInPlace.md +1 -1
- package/docs/api/functions/quoteStr.md +1 -1
- package/docs/api/functions/readFilenamesRecursiveSync.md +1 -1
- package/docs/api/functions/readTextFileChunks.md +1 -1
- package/docs/api/functions/readTextFileChunksEx.md +1 -1
- package/docs/api/functions/readableFromAsyncIterable.md +1 -1
- package/docs/api/functions/registerCoreTools.md +1 -1
- package/docs/api/functions/removeMarkdownBold.md +1 -1
- package/docs/api/functions/removeMarkdownBoldAndItalic.md +1 -1
- package/docs/api/functions/removeMarkdownItalic.md +1 -1
- package/docs/api/functions/replaceWithPlaceholder.md +1 -1
- package/docs/api/functions/restoreFromPlacehoders.md +1 -1
- package/docs/api/functions/saveConfigFile.md +1 -1
- package/docs/api/functions/scaleStrToParamsSize.md +1 -1
- package/docs/api/functions/shutdown.md +1 -1
- package/docs/api/functions/simplifyObjectArguments.md +1 -1
- package/docs/api/functions/sleep.md +1 -1
- package/docs/api/functions/sortedValues.md +1 -1
- package/docs/api/functions/splitChunks.md +1 -1
- package/docs/api/functions/splitParagraph.md +1 -1
- package/docs/api/functions/splitSentence.md +1 -1
- package/docs/api/functions/splitWords.md +1 -1
- package/docs/api/functions/stripConsoleColor.md +1 -1
- package/docs/api/functions/textToDate.md +1 -1
- package/docs/api/functions/toDateTime.md +1 -1
- package/docs/api/functions/trimStartOfStreamHelper.md +1 -1
- package/docs/api/functions/truncTo.md +1 -1
- package/docs/api/functions/truncateByToken.md +1 -1
- package/docs/api/functions/truncateToTokenLimit.md +1 -1
- package/docs/api/functions/truncateToTokenLimitEx.md +1 -1
- package/docs/api/functions/uuid.md +1 -1
- package/docs/api/functions/wait.md +1 -1
- package/docs/api/functions/xxhash.md +1 -1
- package/docs/api/functions/xxhash32.md +1 -1
- package/docs/api/functions/xxhash64.md +1 -1
- package/docs/api/functions/xxhashAsStr.md +1 -1
- package/docs/api/functions/yieldExec.md +1 -1
- package/docs/api/globals.md +6 -0
- package/docs/api/interfaces/AIChatAssistantMessageParam.md +12 -12
- package/docs/api/interfaces/AIChatContentPartImage.md +3 -3
- package/docs/api/interfaces/AIChatContentPartText.md +3 -3
- package/docs/api/interfaces/AIChatMessageParamBase.md +7 -7
- package/docs/api/interfaces/AIChatMessageToolCall.md +4 -4
- package/docs/api/interfaces/AIChatSystemMessageParam.md +9 -9
- package/docs/api/interfaces/AIChatToolChoiceFuncObject.md +3 -3
- package/docs/api/interfaces/AIChatToolChoiceObject.md +2 -2
- package/docs/api/interfaces/AIChatToolFunc.md +5 -5
- package/docs/api/interfaces/AIChatToolFuncParam.md +3 -3
- package/docs/api/interfaces/AIChatToolMessageParam.md +10 -10
- package/docs/api/interfaces/AIChatToolParam.md +2 -2
- package/docs/api/interfaces/AIChatToolTypeObject.md +2 -2
- package/docs/api/interfaces/AIChatUserMessageParam.md +13 -13
- package/docs/api/interfaces/AIChoiceConfig.md +8 -8
- package/docs/api/interfaces/AIResult.md +6 -6
- package/docs/api/interfaces/AIStreamParser.md +2 -2
- package/docs/api/interfaces/AIStreamParserOptions.md +2 -2
- package/docs/api/interfaces/BaseFunc.md +15 -15
- package/docs/api/interfaces/BaseFuncItem.md +14 -14
- package/docs/api/interfaces/BinarySemaphoreAcquireOptions.md +2 -2
- package/docs/api/interfaces/BinarySemaphoreOptions.md +5 -5
- package/docs/api/interfaces/BinarySemaphoreReleaseOptions.md +2 -2
- package/docs/api/interfaces/BinarySemaphoreReleaserFunc.md +3 -3
- package/docs/api/interfaces/CancelableAbilityOptions.md +4 -4
- package/docs/api/interfaces/ClientFuncItem.md +17 -17
- package/docs/api/interfaces/EventClientFuncParams.md +5 -5
- package/docs/api/interfaces/EventServerFuncParams.md +6 -6
- package/docs/api/interfaces/FewShotPromptTemplateOptions.md +6 -6
- package/docs/api/interfaces/FuncItem.md +15 -15
- package/docs/api/interfaces/FuncParam.md +5 -5
- package/docs/api/interfaces/FuncParams.md +1 -1
- package/docs/api/interfaces/Funcs.md +1 -1
- package/docs/api/interfaces/HashAlgoParams.md +4 -4
- package/docs/api/interfaces/IClientToolTransport.md +7 -7
- package/docs/api/interfaces/IFileMetaInfo.md +8 -8
- package/docs/api/interfaces/IPubSubClientTransport.md +3 -3
- package/docs/api/interfaces/IPubSubServerTransport.md +9 -9
- package/docs/api/interfaces/IReadTextFileChunksOptions.md +11 -11
- package/docs/api/interfaces/IServerToolTransport.md +8 -8
- package/docs/api/interfaces/IToolTransport.md +5 -5
- package/docs/api/interfaces/ITruncateToTokenLimitOptions.md +10 -10
- package/docs/api/interfaces/JsonFilter.md +1 -1
- package/docs/api/interfaces/ParseObjectArgumentOptions.md +11 -11
- package/docs/api/interfaces/ProbabilityItem.md +4 -4
- package/docs/api/interfaces/PromptExampleSelectorOptions.md +3 -3
- package/docs/api/interfaces/PubSubClient.md +2 -2
- package/docs/api/interfaces/PubSubClientStream.md +9 -9
- package/docs/api/interfaces/PubSubServerSession.md +7 -7
- package/docs/api/interfaces/RemoteFuncItem.md +17 -17
- package/docs/api/interfaces/ReplacePlacehoderOptions.md +5 -5
- package/docs/api/interfaces/ResClientFuncParams.md +5 -5
- package/docs/api/interfaces/ResServerFuncParams.md +14 -10
- package/docs/api/interfaces/RpcMethodsClientFuncParams.md +25 -0
- package/docs/api/interfaces/RpcMethodsServerFuncParams.md +61 -0
- package/docs/api/interfaces/SectionStringOptions.md +3 -3
- package/docs/api/interfaces/SemaphoreOptions.md +7 -7
- package/docs/api/interfaces/SemaphoreTaskItem.md +5 -5
- package/docs/api/interfaces/ServerFuncItem.md +18 -18
- package/docs/api/interfaces/ServerFuncParams.md +4 -3
- package/docs/api/interfaces/SplitSentenceOptions.md +5 -5
- package/docs/api/interfaces/StreamCallbacksAndOptions.md +5 -5
- package/docs/api/interfaces/TaskAbortControllers.md +1 -1
- package/docs/api/interfaces/TaskPromise.md +2 -2
- package/docs/api/interfaces/ToolFuncPackage.md +4 -4
- package/docs/api/type-aliases/AIChatContentPart.md +1 -1
- package/docs/api/type-aliases/AIChatMessageParam.md +1 -1
- package/docs/api/type-aliases/AIChatRole.md +1 -1
- package/docs/api/type-aliases/AIChatToolChoiceParam.md +1 -1
- package/docs/api/type-aliases/AIMessageType.md +1 -1
- package/docs/api/type-aliases/AIModelNameRule.md +1 -1
- package/docs/api/type-aliases/AIModelNameRuleFn.md +1 -1
- package/docs/api/type-aliases/AIModelNameRules.md +1 -1
- package/docs/api/type-aliases/AITextGenerationFinishReason.md +1 -1
- package/docs/api/type-aliases/ActionName.md +1 -1
- package/docs/api/type-aliases/ArrayMergeWay.md +1 -1
- package/docs/api/type-aliases/AsyncTaskId.md +1 -1
- package/docs/api/type-aliases/BeforeShutdownListener.md +1 -1
- package/docs/api/type-aliases/EventErrorListenerFn.md +1 -1
- package/docs/api/type-aliases/EventListenerFn.md +1 -1
- package/docs/api/type-aliases/FuncParamType.md +1 -1
- package/docs/api/type-aliases/PromptExamples.md +1 -1
- package/docs/api/type-aliases/PubSubClientId.md +1 -1
- package/docs/api/type-aliases/PubSubCtx.md +1 -1
- package/docs/api/type-aliases/RpcMethodHandler.md +1 -1
- package/docs/api/type-aliases/SemaphoreIsReadyFuncType.md +1 -1
- package/docs/api/type-aliases/TFunc.md +1 -1
- package/docs/api/variables/AIChatRoles.md +1 -1
- package/docs/api/variables/AIMessageTypes.md +1 -1
- package/docs/api/variables/AITextGenerationFinishReasons.md +1 -1
- package/docs/api/variables/ActionNames.md +1 -1
- package/docs/api/variables/ArrayMergeWay.md +1 -1
- package/docs/api/variables/ArrayMergeWaySymbol.md +1 -1
- package/docs/api/variables/ClientToolFuncSchema.md +1 -1
- package/docs/api/variables/DEFAULT_CONFIG_NAME.md +1 -1
- package/docs/api/variables/DefaultAsyncSemaphoreCapacity.md +1 -1
- package/docs/api/variables/EventBusName.md +1 -1
- package/docs/api/variables/EventName.md +1 -1
- package/docs/api/variables/FuncMetaSymbol.md +1 -1
- package/docs/api/variables/LLM_TOKENIZER_NAMES.md +1 -1
- package/docs/api/variables/LLM_TOKENIZER_NAMES_MAP.md +1 -1
- package/docs/api/variables/PASSING_SCORE.md +1 -1
- package/docs/api/variables/RStreamErrCode.md +1 -1
- package/docs/api/variables/RemoteToolFuncSchema.md +1 -1
- package/docs/api/variables/ResponseRStreamErrCode.md +1 -1
- package/docs/api/variables/RpcMethodsClientToolSchema.md +49 -0
- package/docs/api/variables/RpcMethodsServerToolSchema.md +21 -0
- package/docs/api/variables/SHUTDOWN_SIGNALS.md +1 -1
- package/docs/api/variables/SSEChannelAlreadyClosedErrCode.md +1 -1
- package/docs/api/variables/SecondaryCache.md +1 -1
- package/docs/api/variables/ServerToolFuncSchema.md +1 -1
- package/docs/api/variables/StrangeHumanName.md +1 -1
- package/docs/api/variables/ToolAsyncCancelableBit.md +1 -1
- package/docs/api/variables/ToolAsyncMultiTaskBit.md +1 -1
- package/docs/api/variables/ToolAsyncPriorityBit.md +1 -1
- package/docs/api/variables/ToolFuncSchema.md +1 -1
- package/docs/api/variables/base32768.md +1 -1
- package/docs/api/variables/event.md +1 -1
- package/docs/api/variables/eventClient.md +1 -1
- package/docs/api/variables/eventServer.md +1 -1
- package/docs/api/variables/lrucache.md +1 -1
- package/package.json +3 -3
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: ServerTools
|
|
8
8
|
|
|
9
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:41](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:41](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/server-tools.ts#L41)
|
|
10
10
|
|
|
11
11
|
Represents a function that runs on a server and can be exposed to clients.
|
|
12
12
|
|
|
@@ -18,6 +18,10 @@ server-side execution contexts. It is designed to work with a transport layer
|
|
|
18
18
|
|
|
19
19
|
- [`ServerFuncItem`](../interfaces/ServerFuncItem.md).[`ToolFunc`](ToolFunc.md)
|
|
20
20
|
|
|
21
|
+
## Extended by
|
|
22
|
+
|
|
23
|
+
- [`RpcMethodsServerTool`](RpcMethodsServerTool.md)
|
|
24
|
+
|
|
21
25
|
## Indexable
|
|
22
26
|
|
|
23
27
|
\[`name`: `string`\]: `any`
|
|
@@ -28,7 +32,7 @@ server-side execution contexts. It is designed to work with a transport layer
|
|
|
28
32
|
|
|
29
33
|
> **new ServerTools**(`name`, `options`?): [`ServerTools`](ServerTools.md)
|
|
30
34
|
|
|
31
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:571](https://github.com/isdk/ai-tool.js/blob/
|
|
35
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:571](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L571)
|
|
32
36
|
|
|
33
37
|
The initial value of Object.prototype.constructor is the standard built-in Object constructor.
|
|
34
38
|
|
|
@@ -72,7 +76,7 @@ Defined in: [property-manager.js/src/advance.d.ts:5](https://github.com/snowyu/p
|
|
|
72
76
|
|
|
73
77
|
> `optional` **action**: `"get"` \| `"post"` \| `"put"` \| `"delete"` \| `"patch"` \| `"list"` \| `"res"`
|
|
74
78
|
|
|
75
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:95](https://github.com/isdk/ai-tool.js/blob/
|
|
79
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:95](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/consts.ts#L95)
|
|
76
80
|
|
|
77
81
|
The action to be used for the remote call. This typically represents an RPC method name.
|
|
78
82
|
Only for RESTful HTTP transports, it might be mapped to a standard HTTP method (e.g., GET, POST)
|
|
@@ -87,7 +91,7 @@ Only for RESTful HTTP transports, it might be mapped to a standard HTTP method (
|
|
|
87
91
|
|
|
88
92
|
> `optional` **alias**: `string` \| `string`[]
|
|
89
93
|
|
|
90
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:130](https://github.com/isdk/ai-tool.js/blob/
|
|
94
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:130](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L130)
|
|
91
95
|
|
|
92
96
|
Optional aliases for the function name.
|
|
93
97
|
|
|
@@ -101,7 +105,7 @@ Optional aliases for the function name.
|
|
|
101
105
|
|
|
102
106
|
> `optional` **allowExportFunc**: `boolean`
|
|
103
107
|
|
|
104
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:35](https://github.com/isdk/ai-tool.js/blob/
|
|
108
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:35](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/server-tools.ts#L35)
|
|
105
109
|
|
|
106
110
|
If set to true, the body of the function (`func`) will be serialized and sent
|
|
107
111
|
to the client when tools are loaded. This allows the client to execute the
|
|
@@ -117,7 +121,7 @@ function locally instead of making a remote call. Defaults to false.
|
|
|
117
121
|
|
|
118
122
|
> `optional` **apiRoot**: `string`
|
|
119
123
|
|
|
120
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:89](https://github.com/isdk/ai-tool.js/blob/
|
|
124
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:89](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/consts.ts#L89)
|
|
121
125
|
|
|
122
126
|
The root endpoint for the remote service.
|
|
123
127
|
|
|
@@ -135,7 +139,7 @@ Use `transport` instead.
|
|
|
135
139
|
|
|
136
140
|
> `optional` **asyncFeatures**: `number`
|
|
137
141
|
|
|
138
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:144](https://github.com/isdk/ai-tool.js/blob/
|
|
142
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:144](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L144)
|
|
139
143
|
|
|
140
144
|
A bitmask representing asynchronous features supported by the function, built from `AsyncFeatureBits`.
|
|
141
145
|
This allows the system to understand if a function supports capabilities like cancellation or multi-tasking.
|
|
@@ -197,7 +201,7 @@ The default options for export and assign
|
|
|
197
201
|
|
|
198
202
|
> `optional` **depends**: `object`
|
|
199
203
|
|
|
200
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:167](https://github.com/isdk/ai-tool.js/blob/
|
|
204
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:167](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L167)
|
|
201
205
|
|
|
202
206
|
A map of dependencies this function has on other tool functions.
|
|
203
207
|
Declaring dependencies ensures that they are automatically registered when this function is registered.
|
|
@@ -236,7 +240,7 @@ mainFunc.register();
|
|
|
236
240
|
|
|
237
241
|
> `optional` **description**: `string`
|
|
238
242
|
|
|
239
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:172](https://github.com/isdk/ai-tool.js/blob/
|
|
243
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:172](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L172)
|
|
240
244
|
|
|
241
245
|
A detailed description of what the function does.
|
|
242
246
|
|
|
@@ -250,7 +254,7 @@ A detailed description of what the function does.
|
|
|
250
254
|
|
|
251
255
|
> `optional` **fetchOptions**: `any`
|
|
252
256
|
|
|
253
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:101](https://github.com/isdk/ai-tool.js/blob/
|
|
257
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:101](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/consts.ts#L101)
|
|
254
258
|
|
|
255
259
|
Options to be passed to the underlying `fetch` call in an HTTP transport.
|
|
256
260
|
|
|
@@ -268,7 +272,7 @@ Use `transport` instead.
|
|
|
268
272
|
|
|
269
273
|
> `optional` **isApi**: `boolean`
|
|
270
274
|
|
|
271
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:119](https://github.com/isdk/ai-tool.js/blob/
|
|
275
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:119](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L119)
|
|
272
276
|
|
|
273
277
|
If true, indicates that this function should be treated as a server-side API.
|
|
274
278
|
|
|
@@ -282,7 +286,7 @@ If true, indicates that this function should be treated as a server-side API.
|
|
|
282
286
|
|
|
283
287
|
> `optional` **name**: `string`
|
|
284
288
|
|
|
285
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:76](https://github.com/isdk/ai-tool.js/blob/
|
|
289
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:76](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L76)
|
|
286
290
|
|
|
287
291
|
The unique name of the function.
|
|
288
292
|
|
|
@@ -310,7 +314,7 @@ the property with the default prefix '$' will not be exported.
|
|
|
310
314
|
|
|
311
315
|
> `optional` **params**: [`FuncParams`](../interfaces/FuncParams.md) \| [`FuncParam`](../interfaces/FuncParam.md)[]
|
|
312
316
|
|
|
313
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:81](https://github.com/isdk/ai-tool.js/blob/
|
|
317
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:81](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L81)
|
|
314
318
|
|
|
315
319
|
Parameter definitions, which can be an object mapping names to definitions or an array for positional parameters.
|
|
316
320
|
|
|
@@ -324,7 +328,7 @@ Parameter definitions, which can be an object mapping names to definitions or an
|
|
|
324
328
|
|
|
325
329
|
> `optional` **result**: `string` \| `Record`\<`string`, `any`\>
|
|
326
330
|
|
|
327
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:86](https://github.com/isdk/ai-tool.js/blob/
|
|
331
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:86](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L86)
|
|
328
332
|
|
|
329
333
|
The expected return type of the function, described as a string or a JSON schema object.
|
|
330
334
|
|
|
@@ -338,7 +342,7 @@ The expected return type of the function, described as a string or a JSON schema
|
|
|
338
342
|
|
|
339
343
|
> `optional` **scope**: `any`
|
|
340
344
|
|
|
341
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:91](https://github.com/isdk/ai-tool.js/blob/
|
|
345
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:91](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L91)
|
|
342
346
|
|
|
343
347
|
The execution scope or context (`this`) for the function.
|
|
344
348
|
|
|
@@ -352,7 +356,7 @@ The execution scope or context (`this`) for the function.
|
|
|
352
356
|
|
|
353
357
|
> `optional` **setup**: (`this`, `options`?) => `void`
|
|
354
358
|
|
|
355
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:114](https://github.com/isdk/ai-tool.js/blob/
|
|
359
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:114](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L114)
|
|
356
360
|
|
|
357
361
|
A lifecycle hook called once during the `ToolFunc` instance's initialization.
|
|
358
362
|
It allows for initial setup, state configuration, or property modification on the instance
|
|
@@ -398,7 +402,7 @@ console.log(myFunc.customState); // Outputs: 'configured'
|
|
|
398
402
|
|
|
399
403
|
> `optional` **stream**: `boolean`
|
|
400
404
|
|
|
401
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:125](https://github.com/isdk/ai-tool.js/blob/
|
|
405
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:125](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L125)
|
|
402
406
|
|
|
403
407
|
If true, indicates that the function has the *capability* to stream its output.
|
|
404
408
|
Whether a specific call is streamed is determined by a `stream` property in the runtime parameters.
|
|
@@ -413,7 +417,7 @@ Whether a specific call is streamed is determined by a `stream` property in the
|
|
|
413
417
|
|
|
414
418
|
> `optional` **tags**: `string` \| `string`[]
|
|
415
419
|
|
|
416
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:96](https://github.com/isdk/ai-tool.js/blob/
|
|
420
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:96](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L96)
|
|
417
421
|
|
|
418
422
|
Tags for grouping or filtering functions.
|
|
419
423
|
|
|
@@ -427,7 +431,7 @@ Tags for grouping or filtering functions.
|
|
|
427
431
|
|
|
428
432
|
> `optional` **title**: `string`
|
|
429
433
|
|
|
430
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:177](https://github.com/isdk/ai-tool.js/blob/
|
|
434
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:177](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L177)
|
|
431
435
|
|
|
432
436
|
A concise, human-readable title for the function, often used in UI or by AI.
|
|
433
437
|
|
|
@@ -441,7 +445,7 @@ A concise, human-readable title for the function, often used in UI or by AI.
|
|
|
441
445
|
|
|
442
446
|
> `static` **aliases**: `object` = `{}`
|
|
443
447
|
|
|
444
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:305](https://github.com/isdk/ai-tool.js/blob/
|
|
448
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:305](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L305)
|
|
445
449
|
|
|
446
450
|
A static map of aliases to their corresponding function names.
|
|
447
451
|
|
|
@@ -459,7 +463,7 @@ A static map of aliases to their corresponding function names.
|
|
|
459
463
|
|
|
460
464
|
> `static` **dataPath**: `string`
|
|
461
465
|
|
|
462
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:312](https://github.com/isdk/ai-tool.js/blob/
|
|
466
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:312](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L312)
|
|
463
467
|
|
|
464
468
|
A conventional property to designate a file path for saving the registered `ToolFunc` data.
|
|
465
469
|
Note: The `ToolFunc` class itself does not implement persistence logic. It is up to the
|
|
@@ -475,7 +479,7 @@ developer to use this path to save and load the `ToolFunc.items` registry if nee
|
|
|
475
479
|
|
|
476
480
|
> `static` **items**: [`Funcs`](../interfaces/Funcs.md) = `{}`
|
|
477
481
|
|
|
478
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:300](https://github.com/isdk/ai-tool.js/blob/
|
|
482
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:300](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L300)
|
|
479
483
|
|
|
480
484
|
A static registry of all `ToolFunc` instances, indexed by name.
|
|
481
485
|
|
|
@@ -491,7 +495,7 @@ A static registry of all `ToolFunc` instances, indexed by name.
|
|
|
491
495
|
|
|
492
496
|
> **get** `static` **apiRoot**(): `undefined` \| `string`
|
|
493
497
|
|
|
494
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:57](https://github.com/isdk/ai-tool.js/blob/
|
|
498
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:57](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/server-tools.ts#L57)
|
|
495
499
|
|
|
496
500
|
The conventional root path for the API endpoint.
|
|
497
501
|
|
|
@@ -509,7 +513,7 @@ The conventional root path for the API endpoint.
|
|
|
509
513
|
|
|
510
514
|
> **arr2ObjParams**(`params`): `any`[]
|
|
511
515
|
|
|
512
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:629](https://github.com/isdk/ai-tool.js/blob/
|
|
516
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:629](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L629)
|
|
513
517
|
|
|
514
518
|
Converts an array of positional arguments into a named parameters object.
|
|
515
519
|
This is used internally to support functions defined with named parameters.
|
|
@@ -820,7 +824,7 @@ the dest object.
|
|
|
820
824
|
|
|
821
825
|
> **func**(`params`): `any`
|
|
822
826
|
|
|
823
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:112](https://github.com/isdk/ai-tool.js/blob/
|
|
827
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:112](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/server-tools.ts#L112)
|
|
824
828
|
|
|
825
829
|
Placeholder for the actual server-side function implementation.
|
|
826
830
|
This method is intended to be defined when a `ServerTools` instance is created.
|
|
@@ -849,7 +853,7 @@ The result of the function.
|
|
|
849
853
|
|
|
850
854
|
> **getFunc**(`name`?): `any`
|
|
851
855
|
|
|
852
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:720](https://github.com/isdk/ai-tool.js/blob/
|
|
856
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:720](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L720)
|
|
853
857
|
|
|
854
858
|
Gets a bound function reference for execution with named parameters.
|
|
855
859
|
If a name is provided, it retrieves a different function from the registry.
|
|
@@ -879,7 +883,7 @@ A function reference or `undefined` if not found.
|
|
|
879
883
|
|
|
880
884
|
> **getFuncWithPos**(`name`?): `any`
|
|
881
885
|
|
|
882
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:777](https://github.com/isdk/ai-tool.js/blob/
|
|
886
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:777](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L777)
|
|
883
887
|
|
|
884
888
|
Gets a bound function reference suitable for positional argument execution.
|
|
885
889
|
If a name is provided, it retrieves a different function from the registry.
|
|
@@ -929,7 +933,7 @@ the descriptors of properties object
|
|
|
929
933
|
|
|
930
934
|
> **hasAsyncFeature**(`feature`): `boolean`
|
|
931
935
|
|
|
932
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:787](https://github.com/isdk/ai-tool.js/blob/
|
|
936
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:787](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L787)
|
|
933
937
|
|
|
934
938
|
Checks if the current function instance supports a specific async feature.
|
|
935
939
|
|
|
@@ -1065,7 +1069,7 @@ The source object
|
|
|
1065
1069
|
|
|
1066
1070
|
> **isStream**(`params`): `undefined` \| `boolean`
|
|
1067
1071
|
|
|
1068
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:805](https://github.com/isdk/ai-tool.js/blob/
|
|
1072
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:805](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L805)
|
|
1069
1073
|
|
|
1070
1074
|
Determines if a function call should produce a stream.
|
|
1071
1075
|
|
|
@@ -1131,7 +1135,7 @@ the dest object.
|
|
|
1131
1135
|
|
|
1132
1136
|
> **obj2ArrParams**(`params`?): `any`[]
|
|
1133
1137
|
|
|
1134
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:648](https://github.com/isdk/ai-tool.js/blob/
|
|
1138
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:648](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L648)
|
|
1135
1139
|
|
|
1136
1140
|
Converts a named parameters object into an array of positional arguments.
|
|
1137
1141
|
This is used for functions defined with positional parameters.
|
|
@@ -1186,7 +1190,7 @@ A property name.
|
|
|
1186
1190
|
|
|
1187
1191
|
> **register**(): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
1188
1192
|
|
|
1189
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:602](https://github.com/isdk/ai-tool.js/blob/
|
|
1193
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:602](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L602)
|
|
1190
1194
|
|
|
1191
1195
|
Registers the current `ToolFunc` instance into the static registry.
|
|
1192
1196
|
Also registers any declared dependencies.
|
|
@@ -1207,7 +1211,7 @@ The instance itself upon successful registration, or `false` if it already exist
|
|
|
1207
1211
|
|
|
1208
1212
|
> **run**(`params`, `context`?): `Promise`\<`any`\>
|
|
1209
1213
|
|
|
1210
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:98](https://github.com/isdk/ai-tool.js/blob/
|
|
1214
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:98](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/server-tools.ts#L98)
|
|
1211
1215
|
|
|
1212
1216
|
Overrides the base `run` method to inject transport-specific context.
|
|
1213
1217
|
If a `context` object containing `req` and `reply` is provided, these are
|
|
@@ -1249,7 +1253,7 @@ The result of the function execution.
|
|
|
1249
1253
|
|
|
1250
1254
|
> **runAs**(`name`, `params`?): `Promise`\<`any`\>
|
|
1251
1255
|
|
|
1252
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:697](https://github.com/isdk/ai-tool.js/blob/
|
|
1256
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:697](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L697)
|
|
1253
1257
|
|
|
1254
1258
|
Asynchronously executes another registered function by name.
|
|
1255
1259
|
This method delegates to `runAsSync()` internally.
|
|
@@ -1284,7 +1288,7 @@ A promise that resolves with the result of the function execution.
|
|
|
1284
1288
|
|
|
1285
1289
|
> **runAsSync**(`name`, `params`?): `any`
|
|
1286
1290
|
|
|
1287
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:708](https://github.com/isdk/ai-tool.js/blob/
|
|
1291
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:708](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L708)
|
|
1288
1292
|
|
|
1289
1293
|
Synchronously executes another registered function by name.
|
|
1290
1294
|
This is a convenience method that forwards the call to the static `runSync()` method.
|
|
@@ -1319,7 +1323,7 @@ The result of the function execution.
|
|
|
1319
1323
|
|
|
1320
1324
|
> **runSync**(`params`?): `any`
|
|
1321
1325
|
|
|
1322
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:667](https://github.com/isdk/ai-tool.js/blob/
|
|
1326
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:667](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L667)
|
|
1323
1327
|
|
|
1324
1328
|
Executes the function synchronously with a named parameters object.
|
|
1325
1329
|
|
|
@@ -1351,7 +1355,7 @@ Will throw an error if an array of parameters is passed to a function that expec
|
|
|
1351
1355
|
|
|
1352
1356
|
> **runWithPos**(...`params`): `Promise`\<`any`\>
|
|
1353
1357
|
|
|
1354
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:755](https://github.com/isdk/ai-tool.js/blob/
|
|
1358
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:755](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L755)
|
|
1355
1359
|
|
|
1356
1360
|
Executes the function asynchronously using positional arguments.
|
|
1357
1361
|
Delegates to `runWithPosSync()` internally.
|
|
@@ -1380,7 +1384,7 @@ A promise that resolves with the result of the function execution.
|
|
|
1380
1384
|
|
|
1381
1385
|
> **runWithPosAs**(`name`, ...`params`): `Promise`\<`any`\>
|
|
1382
1386
|
|
|
1383
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:766](https://github.com/isdk/ai-tool.js/blob/
|
|
1387
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:766](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L766)
|
|
1384
1388
|
|
|
1385
1389
|
Asynchronously executes another function by name using positional arguments.
|
|
1386
1390
|
Delegates to `runWithPosAsSync()` internally.
|
|
@@ -1415,7 +1419,7 @@ A promise that resolves with the result of the function execution.
|
|
|
1415
1419
|
|
|
1416
1420
|
> **runWithPosAsSync**(`name`, ...`params`): `any`
|
|
1417
1421
|
|
|
1418
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:745](https://github.com/isdk/ai-tool.js/blob/
|
|
1422
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:745](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L745)
|
|
1419
1423
|
|
|
1420
1424
|
Synchronously executes another function by name using positional arguments.
|
|
1421
1425
|
This is a convenience wrapper around the static `runWithPosSync()` method.
|
|
@@ -1450,7 +1454,7 @@ The result of the function execution.
|
|
|
1450
1454
|
|
|
1451
1455
|
> **runWithPosSync**(...`params`): `any`
|
|
1452
1456
|
|
|
1453
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:731](https://github.com/isdk/ai-tool.js/blob/
|
|
1457
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:731](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L731)
|
|
1454
1458
|
|
|
1455
1459
|
Executes the function synchronously using positional arguments.
|
|
1456
1460
|
If the function expects named parameters, it converts the arguments automatically.
|
|
@@ -1557,7 +1561,7 @@ Returns a string representation of an object.
|
|
|
1557
1561
|
|
|
1558
1562
|
> **unregister**(): `any`
|
|
1559
1563
|
|
|
1560
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:619](https://github.com/isdk/ai-tool.js/blob/
|
|
1564
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:619](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L619)
|
|
1561
1565
|
|
|
1562
1566
|
Removes the current `ToolFunc` instance from the static registry.
|
|
1563
1567
|
|
|
@@ -2097,7 +2101,7 @@ An iterable object that contains key-value entries for properties and methods.
|
|
|
2097
2101
|
|
|
2098
2102
|
> `static` **get**(`name`): [`ToolFunc`](ToolFunc.md)
|
|
2099
2103
|
|
|
2100
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:319](https://github.com/isdk/ai-tool.js/blob/
|
|
2104
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:319](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L319)
|
|
2101
2105
|
|
|
2102
2106
|
Retrieves a registered function by its name or alias.
|
|
2103
2107
|
|
|
@@ -2125,7 +2129,7 @@ The `ToolFunc` instance if found, otherwise `undefined`.
|
|
|
2125
2129
|
|
|
2126
2130
|
> `static` **getAllByTag**(`tagName`): [`ToolFunc`](ToolFunc.md)[]
|
|
2127
2131
|
|
|
2128
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:365](https://github.com/isdk/ai-tool.js/blob/
|
|
2132
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:365](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L365)
|
|
2129
2133
|
|
|
2130
2134
|
Retrieves all registered functions that have a specific tag.
|
|
2131
2135
|
|
|
@@ -2153,7 +2157,7 @@ An array of matching `ToolFunc` instances.
|
|
|
2153
2157
|
|
|
2154
2158
|
> `static` **getByTag**(`tagName`): `undefined` \| [`ToolFunc`](ToolFunc.md)
|
|
2155
2159
|
|
|
2156
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:340](https://github.com/isdk/ai-tool.js/blob/
|
|
2160
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:340](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L340)
|
|
2157
2161
|
|
|
2158
2162
|
Finds the first registered function that has a specific tag.
|
|
2159
2163
|
|
|
@@ -2181,7 +2185,7 @@ The first matching `ToolFunc` instance, or `undefined` if none is found.
|
|
|
2181
2185
|
|
|
2182
2186
|
> `static` **getFunc**(`name`): `any`
|
|
2183
2187
|
|
|
2184
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:431](https://github.com/isdk/ai-tool.js/blob/
|
|
2188
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:431](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L431)
|
|
2185
2189
|
|
|
2186
2190
|
Retrieves a bound, runnable function reference for a registered function.
|
|
2187
2191
|
This reference is suitable for execution with an object of named parameters.
|
|
@@ -2210,7 +2214,7 @@ A bound function reference, or `undefined` if not found.
|
|
|
2210
2214
|
|
|
2211
2215
|
> `static` **getFuncWithPos**(`name`): `any`
|
|
2212
2216
|
|
|
2213
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:472](https://github.com/isdk/ai-tool.js/blob/
|
|
2217
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:472](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L472)
|
|
2214
2218
|
|
|
2215
2219
|
Retrieves a bound, runnable function reference for a registered function.
|
|
2216
2220
|
This reference is suitable for execution with positional arguments.
|
|
@@ -2399,7 +2403,7 @@ The object that references the prototype.
|
|
|
2399
2403
|
|
|
2400
2404
|
> `static` **hasAsyncFeature**(`feature`): `boolean`
|
|
2401
2405
|
|
|
2402
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:388](https://github.com/isdk/ai-tool.js/blob/
|
|
2406
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:388](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L388)
|
|
2403
2407
|
|
|
2404
2408
|
Checks if any registered function has a specific asynchronous feature.
|
|
2405
2409
|
|
|
@@ -2619,7 +2623,7 @@ Object that contains the properties and methods. This can be an object that you
|
|
|
2619
2623
|
|
|
2620
2624
|
> `static` **list**(): [`Funcs`](../interfaces/Funcs.md)
|
|
2621
2625
|
|
|
2622
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:331](https://github.com/isdk/ai-tool.js/blob/
|
|
2626
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:331](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L331)
|
|
2623
2627
|
|
|
2624
2628
|
Returns the complete map of all registered functions.
|
|
2625
2629
|
|
|
@@ -2671,7 +2675,7 @@ Object to make non-extensible.
|
|
|
2671
2675
|
|
|
2672
2676
|
> `static` **register**(`name`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2673
2677
|
|
|
2674
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:495](https://github.com/isdk/ai-tool.js/blob/
|
|
2678
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:495](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L495)
|
|
2675
2679
|
|
|
2676
2680
|
Registers a new tool function.
|
|
2677
2681
|
|
|
@@ -2707,7 +2711,7 @@ The new `ToolFunc` instance, or `false` if a function with that name already exi
|
|
|
2707
2711
|
|
|
2708
2712
|
> `static` **register**(`func`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2709
2713
|
|
|
2710
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:496](https://github.com/isdk/ai-tool.js/blob/
|
|
2714
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:496](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L496)
|
|
2711
2715
|
|
|
2712
2716
|
Registers a new tool function.
|
|
2713
2717
|
|
|
@@ -2743,7 +2747,7 @@ The new `ToolFunc` instance, or `false` if a function with that name already exi
|
|
|
2743
2747
|
|
|
2744
2748
|
> `static` **register**(`name`, `options`?): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2745
2749
|
|
|
2746
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:497](https://github.com/isdk/ai-tool.js/blob/
|
|
2750
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:497](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L497)
|
|
2747
2751
|
|
|
2748
2752
|
Registers a new tool function.
|
|
2749
2753
|
|
|
@@ -2781,7 +2785,7 @@ The new `ToolFunc` instance, or `false` if a function with that name already exi
|
|
|
2781
2785
|
|
|
2782
2786
|
> `static` **run**(`name`, `params`?): `Promise`\<`any`\>
|
|
2783
2787
|
|
|
2784
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:402](https://github.com/isdk/ai-tool.js/blob/
|
|
2788
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:402](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L402)
|
|
2785
2789
|
|
|
2786
2790
|
Asynchronously executes a registered function by name with named parameters.
|
|
2787
2791
|
|
|
@@ -2819,7 +2823,7 @@ If the function with the given name is not found.
|
|
|
2819
2823
|
|
|
2820
2824
|
> `static` **runSync**(`name`, `params`?): `any`
|
|
2821
2825
|
|
|
2822
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:417](https://github.com/isdk/ai-tool.js/blob/
|
|
2826
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:417](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L417)
|
|
2823
2827
|
|
|
2824
2828
|
Synchronously executes a registered function by name with named parameters.
|
|
2825
2829
|
|
|
@@ -2857,7 +2861,7 @@ If the function with the given name is not found.
|
|
|
2857
2861
|
|
|
2858
2862
|
> `static` **runWithPos**(`name`, ...`params`): `Promise`\<`any`\>
|
|
2859
2863
|
|
|
2860
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:443](https://github.com/isdk/ai-tool.js/blob/
|
|
2864
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:443](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L443)
|
|
2861
2865
|
|
|
2862
2866
|
Asynchronously executes a function using positional arguments.
|
|
2863
2867
|
|
|
@@ -2895,7 +2899,7 @@ If the function with the given name is not found.
|
|
|
2895
2899
|
|
|
2896
2900
|
> `static` **runWithPosSync**(`name`, ...`params`): `any`
|
|
2897
2901
|
|
|
2898
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:458](https://github.com/isdk/ai-tool.js/blob/
|
|
2902
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:458](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L458)
|
|
2899
2903
|
|
|
2900
2904
|
Synchronously executes a function using positional arguments.
|
|
2901
2905
|
|
|
@@ -2963,7 +2967,7 @@ Object on which to lock the attributes.
|
|
|
2963
2967
|
|
|
2964
2968
|
> `static` **setApiRoot**(`v`): `void`
|
|
2965
2969
|
|
|
2966
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:61](https://github.com/isdk/ai-tool.js/blob/
|
|
2970
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:61](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/server-tools.ts#L61)
|
|
2967
2971
|
|
|
2968
2972
|
#### Parameters
|
|
2969
2973
|
|
|
@@ -3013,7 +3017,7 @@ The value of the new prototype or null.
|
|
|
3013
3017
|
|
|
3014
3018
|
> `static` **toJSON**(): `object`
|
|
3015
3019
|
|
|
3016
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:74](https://github.com/isdk/ai-tool.js/blob/
|
|
3020
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:74](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/server-tools.ts#L74)
|
|
3017
3021
|
|
|
3018
3022
|
Serializes all registered `ServerTools` instances into a JSON object.
|
|
3019
3023
|
This method is typically called by a transport's discovery endpoint.
|
|
@@ -3033,7 +3037,7 @@ A map of serializable tool definitions.
|
|
|
3033
3037
|
|
|
3034
3038
|
> `static` **unregister**(`name`): `undefined` \| [`ToolFunc`](ToolFunc.md)
|
|
3035
3039
|
|
|
3036
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:547](https://github.com/isdk/ai-tool.js/blob/
|
|
3040
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:547](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L547)
|
|
3037
3041
|
|
|
3038
3042
|
Unregisters a function by its name, also removing any associated aliases.
|
|
3039
3043
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: SignalGate\<T\>
|
|
8
8
|
|
|
9
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:20](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:20](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/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: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:21](https://github.com/isdk/ai-tool.js/blob/
|
|
47
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:21](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-signal-gate.ts#L21)
|
|
48
48
|
|
|
49
49
|
***
|
|
50
50
|
|
|
@@ -52,7 +52,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:21](
|
|
|
52
52
|
|
|
53
53
|
> `protected` **\_signalValue**: `undefined` \| `T`
|
|
54
54
|
|
|
55
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:22](https://github.com/isdk/ai-tool.js/blob/
|
|
55
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:22](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-signal-gate.ts#L22)
|
|
56
56
|
|
|
57
57
|
***
|
|
58
58
|
|
|
@@ -60,7 +60,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:22](
|
|
|
60
60
|
|
|
61
61
|
> `protected` **waitQueue**: `object`[] = `[]`
|
|
62
62
|
|
|
63
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:23](https://github.com/isdk/ai-tool.js/blob/
|
|
63
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:23](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-signal-gate.ts#L23)
|
|
64
64
|
|
|
65
65
|
#### reject()
|
|
66
66
|
|
|
@@ -98,7 +98,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:23](
|
|
|
98
98
|
|
|
99
99
|
> **get** **signaled**(): `boolean`
|
|
100
100
|
|
|
101
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:28](https://github.com/isdk/ai-tool.js/blob/
|
|
101
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:28](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-signal-gate.ts#L28)
|
|
102
102
|
|
|
103
103
|
##### Returns
|
|
104
104
|
|
|
@@ -110,7 +110,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:28](
|
|
|
110
110
|
|
|
111
111
|
> **abort**(`reason`?): `void`
|
|
112
112
|
|
|
113
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:65](https://github.com/isdk/ai-tool.js/blob/
|
|
113
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:65](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/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: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:53](https://github.com/isdk/ai-tool.js/blob/
|
|
136
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:53](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/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: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:38](https://github.com/isdk/ai-tool.js/blob/
|
|
150
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:38](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/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: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:83](https://github.com/isdk/ai-tool.js/blob/
|
|
173
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:83](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/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: SseClientPubSubTransport
|
|
8
8
|
|
|
9
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-client.ts:4](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-client.ts:4](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/pubsub/sse-client.ts#L4)
|
|
10
10
|
|
|
11
11
|
Defines the interface for a client-side PubSub transport.
|
|
12
12
|
|
|
@@ -33,7 +33,7 @@ stream (`PubSubClientStream`) to the server.
|
|
|
33
33
|
|
|
34
34
|
> **connect**(`url`, `params`?): [`PubSubClientStream`](../interfaces/PubSubClientStream.md)
|
|
35
35
|
|
|
36
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-client.ts:5](https://github.com/isdk/ai-tool.js/blob/
|
|
36
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-client.ts:5](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/pubsub/sse-client.ts#L5)
|
|
37
37
|
|
|
38
38
|
Establishes a connection to a server endpoint.
|
|
39
39
|
|
|
@@ -68,7 +68,7 @@ A `PubSubClientStream` instance that represents the active connection.
|
|
|
68
68
|
|
|
69
69
|
> **disconnect**(`stream`): `void`
|
|
70
70
|
|
|
71
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-client.ts:45](https://github.com/isdk/ai-tool.js/blob/
|
|
71
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-client.ts:45](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/pubsub/sse-client.ts#L45)
|
|
72
72
|
|
|
73
73
|
Optional. Disconnects a given stream.
|
|
74
74
|
While the `close` method exists on the stream itself, placing `disconnect`
|