@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,16 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: EventClient
|
|
8
8
|
|
|
9
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:13](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:13](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/funcs/event-client.ts#L13)
|
|
10
|
+
|
|
11
|
+
Represents a client-side proxy for a remote tool function.
|
|
12
|
+
|
|
13
|
+
A `ClientTools` instance is a `ToolFunc` that, when executed, does not run
|
|
14
|
+
local code. Instead, it serializes the parameters and uses an injected
|
|
15
|
+
transport layer (`IClientToolTransport`) to make a remote procedure call
|
|
16
|
+
to its corresponding `ServerTools` counterpart.
|
|
17
|
+
|
|
18
|
+
These tools are typically created dynamically by loading definitions from a server.
|
|
10
19
|
|
|
11
20
|
## Extends
|
|
12
21
|
|
|
@@ -22,7 +31,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:13](https
|
|
|
22
31
|
|
|
23
32
|
> **new EventClient**(`name`, `options`?): [`EventClient`](EventClient.md)
|
|
24
33
|
|
|
25
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:571](https://github.com/isdk/ai-tool.js/blob/
|
|
34
|
+
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)
|
|
26
35
|
|
|
27
36
|
The initial value of Object.prototype.constructor is the standard built-in Object constructor.
|
|
28
37
|
|
|
@@ -54,7 +63,7 @@ Configuration options if not provided in the first argument.
|
|
|
54
63
|
|
|
55
64
|
> **\_forwardEvents**: `Set`\<`string`\>
|
|
56
65
|
|
|
57
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:25](https://github.com/isdk/ai-tool.js/blob/
|
|
66
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:25](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/funcs/event-client.ts#L25)
|
|
58
67
|
|
|
59
68
|
***
|
|
60
69
|
|
|
@@ -62,7 +71,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:25](https
|
|
|
62
71
|
|
|
63
72
|
> **\_sseListeners**: `Record`\<`string`, (`data`, `ctx`?) => `void`\> = `{}`
|
|
64
73
|
|
|
65
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:24](https://github.com/isdk/ai-tool.js/blob/
|
|
74
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:24](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/funcs/event-client.ts#L24)
|
|
66
75
|
|
|
67
76
|
***
|
|
68
77
|
|
|
@@ -70,7 +79,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:24](https
|
|
|
70
79
|
|
|
71
80
|
> **\_stream**: `undefined` \| [`PubSubClientStream`](../interfaces/PubSubClientStream.md)
|
|
72
81
|
|
|
73
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:21](https://github.com/isdk/ai-tool.js/blob/
|
|
82
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:21](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/funcs/event-client.ts#L21)
|
|
74
83
|
|
|
75
84
|
***
|
|
76
85
|
|
|
@@ -78,7 +87,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:21](https
|
|
|
78
87
|
|
|
79
88
|
> **\_streamEvents**: `undefined` \| `string`[]
|
|
80
89
|
|
|
81
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:22](https://github.com/isdk/ai-tool.js/blob/
|
|
90
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:22](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/funcs/event-client.ts#L22)
|
|
82
91
|
|
|
83
92
|
***
|
|
84
93
|
|
|
@@ -98,7 +107,7 @@ Defined in: [property-manager.js/src/advance.d.ts:5](https://github.com/snowyu/p
|
|
|
98
107
|
|
|
99
108
|
> `optional` **action**: `"get"` \| `"post"` \| `"put"` \| `"delete"` \| `"patch"` \| `"list"` \| `"res"`
|
|
100
109
|
|
|
101
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:95](https://github.com/isdk/ai-tool.js/blob/
|
|
110
|
+
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)
|
|
102
111
|
|
|
103
112
|
The action to be used for the remote call. This typically represents an RPC method name.
|
|
104
113
|
Only for RESTful HTTP transports, it might be mapped to a standard HTTP method (e.g., GET, POST)
|
|
@@ -113,7 +122,7 @@ Only for RESTful HTTP transports, it might be mapped to a standard HTTP method (
|
|
|
113
122
|
|
|
114
123
|
> `optional` **alias**: `string` \| `string`[]
|
|
115
124
|
|
|
116
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:130](https://github.com/isdk/ai-tool.js/blob/
|
|
125
|
+
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)
|
|
117
126
|
|
|
118
127
|
Optional aliases for the function name.
|
|
119
128
|
|
|
@@ -127,7 +136,7 @@ Optional aliases for the function name.
|
|
|
127
136
|
|
|
128
137
|
> `optional` **asyncFeatures**: `number`
|
|
129
138
|
|
|
130
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:144](https://github.com/isdk/ai-tool.js/blob/
|
|
139
|
+
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)
|
|
131
140
|
|
|
132
141
|
A bitmask representing asynchronous features supported by the function, built from `AsyncFeatureBits`.
|
|
133
142
|
This allows the system to understand if a function supports capabilities like cancellation or multi-tasking.
|
|
@@ -193,7 +202,7 @@ The default options for export and assign
|
|
|
193
202
|
|
|
194
203
|
> `optional` **depends**: `object`
|
|
195
204
|
|
|
196
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:167](https://github.com/isdk/ai-tool.js/blob/
|
|
205
|
+
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)
|
|
197
206
|
|
|
198
207
|
A map of dependencies this function has on other tool functions.
|
|
199
208
|
Declaring dependencies ensures that they are automatically registered when this function is registered.
|
|
@@ -232,7 +241,7 @@ mainFunc.register();
|
|
|
232
241
|
|
|
233
242
|
> **description**: `string` = `'subscribe server event'`
|
|
234
243
|
|
|
235
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:49](https://github.com/isdk/ai-tool.js/blob/
|
|
244
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:49](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/funcs/event-client.ts#L49)
|
|
236
245
|
|
|
237
246
|
A detailed description of what the function does.
|
|
238
247
|
|
|
@@ -246,7 +255,7 @@ A detailed description of what the function does.
|
|
|
246
255
|
|
|
247
256
|
> **ebListener**: (`this`, ...`data`) => `Promise`\<`void`\>
|
|
248
257
|
|
|
249
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:83](https://github.com/isdk/ai-tool.js/blob/
|
|
258
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:83](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/funcs/event-client.ts#L83)
|
|
250
259
|
|
|
251
260
|
#### Parameters
|
|
252
261
|
|
|
@@ -268,7 +277,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:83](https
|
|
|
268
277
|
|
|
269
278
|
> `optional` **fetchOptions**: `any`
|
|
270
279
|
|
|
271
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:101](https://github.com/isdk/ai-tool.js/blob/
|
|
280
|
+
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)
|
|
272
281
|
|
|
273
282
|
Options to be passed to the underlying `fetch` call in an HTTP transport.
|
|
274
283
|
|
|
@@ -286,7 +295,7 @@ Use `transport` instead.
|
|
|
286
295
|
|
|
287
296
|
> `optional` **isApi**: `boolean`
|
|
288
297
|
|
|
289
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:119](https://github.com/isdk/ai-tool.js/blob/
|
|
298
|
+
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)
|
|
290
299
|
|
|
291
300
|
If true, indicates that this function should be treated as a server-side API.
|
|
292
301
|
|
|
@@ -300,7 +309,7 @@ If true, indicates that this function should be treated as a server-side API.
|
|
|
300
309
|
|
|
301
310
|
> `optional` **name**: `string`
|
|
302
311
|
|
|
303
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:76](https://github.com/isdk/ai-tool.js/blob/
|
|
312
|
+
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)
|
|
304
313
|
|
|
305
314
|
The unique name of the function.
|
|
306
315
|
|
|
@@ -328,7 +337,7 @@ the property with the default prefix '$' will not be exported.
|
|
|
328
337
|
|
|
329
338
|
> `optional` **params**: [`FuncParams`](../interfaces/FuncParams.md) \| [`FuncParam`](../interfaces/FuncParam.md)[]
|
|
330
339
|
|
|
331
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:81](https://github.com/isdk/ai-tool.js/blob/
|
|
340
|
+
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)
|
|
332
341
|
|
|
333
342
|
Parameter definitions, which can be an object mapping names to definitions or an array for positional parameters.
|
|
334
343
|
|
|
@@ -342,7 +351,7 @@ Parameter definitions, which can be an object mapping names to definitions or an
|
|
|
342
351
|
|
|
343
352
|
> `optional` **result**: `string` \| `Record`\<`string`, `any`\>
|
|
344
353
|
|
|
345
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:86](https://github.com/isdk/ai-tool.js/blob/
|
|
354
|
+
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)
|
|
346
355
|
|
|
347
356
|
The expected return type of the function, described as a string or a JSON schema object.
|
|
348
357
|
|
|
@@ -356,7 +365,7 @@ The expected return type of the function, described as a string or a JSON schema
|
|
|
356
365
|
|
|
357
366
|
> `optional` **scope**: `any`
|
|
358
367
|
|
|
359
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:91](https://github.com/isdk/ai-tool.js/blob/
|
|
368
|
+
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)
|
|
360
369
|
|
|
361
370
|
The execution scope or context (`this`) for the function.
|
|
362
371
|
|
|
@@ -370,7 +379,7 @@ The execution scope or context (`this`) for the function.
|
|
|
370
379
|
|
|
371
380
|
> `optional` **setup**: (`this`, `options`?) => `void`
|
|
372
381
|
|
|
373
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:114](https://github.com/isdk/ai-tool.js/blob/
|
|
382
|
+
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)
|
|
374
383
|
|
|
375
384
|
A lifecycle hook called once during the `ToolFunc` instance's initialization.
|
|
376
385
|
It allows for initial setup, state configuration, or property modification on the instance
|
|
@@ -416,7 +425,7 @@ console.log(myFunc.customState); // Outputs: 'configured'
|
|
|
416
425
|
|
|
417
426
|
> `optional` **stream**: `boolean`
|
|
418
427
|
|
|
419
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:125](https://github.com/isdk/ai-tool.js/blob/
|
|
428
|
+
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)
|
|
420
429
|
|
|
421
430
|
If true, indicates that the function has the *capability* to stream its output.
|
|
422
431
|
Whether a specific call is streamed is determined by a `stream` property in the runtime parameters.
|
|
@@ -431,7 +440,7 @@ Whether a specific call is streamed is determined by a `stream` property in the
|
|
|
431
440
|
|
|
432
441
|
> `optional` **tags**: `string` \| `string`[]
|
|
433
442
|
|
|
434
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:96](https://github.com/isdk/ai-tool.js/blob/
|
|
443
|
+
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)
|
|
435
444
|
|
|
436
445
|
Tags for grouping or filtering functions.
|
|
437
446
|
|
|
@@ -445,7 +454,7 @@ Tags for grouping or filtering functions.
|
|
|
445
454
|
|
|
446
455
|
> `optional` **title**: `string`
|
|
447
456
|
|
|
448
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:177](https://github.com/isdk/ai-tool.js/blob/
|
|
457
|
+
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)
|
|
449
458
|
|
|
450
459
|
A concise, human-readable title for the function, often used in UI or by AI.
|
|
451
460
|
|
|
@@ -459,7 +468,7 @@ A concise, human-readable title for the function, often used in UI or by AI.
|
|
|
459
468
|
|
|
460
469
|
> `static` **\_pubSubTransport**: `undefined` \| [`IPubSubClientTransport`](../interfaces/IPubSubClientTransport.md)
|
|
461
470
|
|
|
462
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:14](https://github.com/isdk/ai-tool.js/blob/
|
|
471
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:14](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/funcs/event-client.ts#L14)
|
|
463
472
|
|
|
464
473
|
***
|
|
465
474
|
|
|
@@ -467,7 +476,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:14](https
|
|
|
467
476
|
|
|
468
477
|
> `static` `optional` **action**: `string`
|
|
469
478
|
|
|
470
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:32](https://github.com/isdk/ai-tool.js/blob/
|
|
479
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:32](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/client-tools.ts#L32)
|
|
471
480
|
|
|
472
481
|
#### Inherited from
|
|
473
482
|
|
|
@@ -479,7 +488,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:32](https://git
|
|
|
479
488
|
|
|
480
489
|
> `static` **aliases**: `object` = `{}`
|
|
481
490
|
|
|
482
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:305](https://github.com/isdk/ai-tool.js/blob/
|
|
491
|
+
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)
|
|
483
492
|
|
|
484
493
|
A static map of aliases to their corresponding function names.
|
|
485
494
|
|
|
@@ -497,7 +506,7 @@ A static map of aliases to their corresponding function names.
|
|
|
497
506
|
|
|
498
507
|
> `static` **dataPath**: `string`
|
|
499
508
|
|
|
500
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:312](https://github.com/isdk/ai-tool.js/blob/
|
|
509
|
+
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)
|
|
501
510
|
|
|
502
511
|
A conventional property to designate a file path for saving the registered `ToolFunc` data.
|
|
503
512
|
Note: The `ToolFunc` class itself does not implement persistence logic. It is up to the
|
|
@@ -513,7 +522,7 @@ developer to use this path to save and load the `ToolFunc.items` registry if nee
|
|
|
513
522
|
|
|
514
523
|
> `static` **items**: [`Funcs`](../interfaces/Funcs.md) = `{}`
|
|
515
524
|
|
|
516
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:300](https://github.com/isdk/ai-tool.js/blob/
|
|
525
|
+
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)
|
|
517
526
|
|
|
518
527
|
A static registry of all `ToolFunc` instances, indexed by name.
|
|
519
528
|
|
|
@@ -529,7 +538,7 @@ A static registry of all `ToolFunc` instances, indexed by name.
|
|
|
529
538
|
|
|
530
539
|
> **get** **active**(): `boolean`
|
|
531
540
|
|
|
532
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:35](https://github.com/isdk/ai-tool.js/blob/
|
|
541
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:35](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/funcs/event-client.ts#L35)
|
|
533
542
|
|
|
534
543
|
##### Returns
|
|
535
544
|
|
|
@@ -539,7 +548,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:35](https
|
|
|
539
548
|
|
|
540
549
|
> **set** **active**(`v`): `void`
|
|
541
550
|
|
|
542
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:39](https://github.com/isdk/ai-tool.js/blob/
|
|
551
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:39](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/funcs/event-client.ts#L39)
|
|
543
552
|
|
|
544
553
|
##### Parameters
|
|
545
554
|
|
|
@@ -553,13 +562,13 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:39](https
|
|
|
553
562
|
|
|
554
563
|
***
|
|
555
564
|
|
|
556
|
-
### apiRoot
|
|
565
|
+
### ~~apiRoot~~
|
|
557
566
|
|
|
558
567
|
#### Get Signature
|
|
559
568
|
|
|
560
569
|
> **get** **apiRoot**(): `string`
|
|
561
570
|
|
|
562
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:109](https://github.com/isdk/ai-tool.js/blob/
|
|
571
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:109](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/client-tools.ts#L109)
|
|
563
572
|
|
|
564
573
|
##### Deprecated
|
|
565
574
|
|
|
@@ -570,6 +579,12 @@ The actual endpoint is managed by the transport.
|
|
|
570
579
|
|
|
571
580
|
`string`
|
|
572
581
|
|
|
582
|
+
The root endpoint for the remote service.
|
|
583
|
+
|
|
584
|
+
#### Deprecated
|
|
585
|
+
|
|
586
|
+
Use `transport` instead.
|
|
587
|
+
|
|
573
588
|
#### Inherited from
|
|
574
589
|
|
|
575
590
|
[`ResClientTools`](ResClientTools.md).[`apiRoot`](ResClientTools.md#apiroot)
|
|
@@ -582,7 +597,7 @@ The actual endpoint is managed by the transport.
|
|
|
582
597
|
|
|
583
598
|
> **get** **evtSource**(): [`PubSubClientStream`](../interfaces/PubSubClientStream.md)
|
|
584
599
|
|
|
585
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:27](https://github.com/isdk/ai-tool.js/blob/
|
|
600
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:27](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/funcs/event-client.ts#L27)
|
|
586
601
|
|
|
587
602
|
##### Returns
|
|
588
603
|
|
|
@@ -596,7 +611,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:27](https
|
|
|
596
611
|
|
|
597
612
|
> **get** `static` **apiRoot**(): `string`
|
|
598
613
|
|
|
599
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:40](https://github.com/isdk/ai-tool.js/blob/
|
|
614
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:40](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/client-tools.ts#L40)
|
|
600
615
|
|
|
601
616
|
##### Deprecated
|
|
602
617
|
|
|
@@ -619,7 +634,7 @@ The actual endpoint is managed by the transport.
|
|
|
619
634
|
|
|
620
635
|
> **get** `static` **pubSubTransport**(): [`IPubSubClientTransport`](../interfaces/IPubSubClientTransport.md)
|
|
621
636
|
|
|
622
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:16](https://github.com/isdk/ai-tool.js/blob/
|
|
637
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:16](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/funcs/event-client.ts#L16)
|
|
623
638
|
|
|
624
639
|
##### Returns
|
|
625
640
|
|
|
@@ -633,7 +648,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:16](https
|
|
|
633
648
|
|
|
634
649
|
> **get** `static` **transport**(): [`IClientToolTransport`](../interfaces/IClientToolTransport.md)
|
|
635
650
|
|
|
636
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:60](https://github.com/isdk/ai-tool.js/blob/
|
|
651
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:60](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/client-tools.ts#L60)
|
|
637
652
|
|
|
638
653
|
##### Returns
|
|
639
654
|
|
|
@@ -649,7 +664,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:60](https://git
|
|
|
649
664
|
|
|
650
665
|
> **\_func**(`action`, `options`): `Promise`\<`any`\>
|
|
651
666
|
|
|
652
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-client-tool.ts:19](https://github.com/isdk/ai-tool.js/blob/
|
|
667
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-client-tool.ts:19](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/rpc-methods-client-tool.ts#L19)
|
|
653
668
|
|
|
654
669
|
#### Parameters
|
|
655
670
|
|
|
@@ -659,7 +674,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-client-tool.ts:19](
|
|
|
659
674
|
|
|
660
675
|
##### options
|
|
661
676
|
|
|
662
|
-
`RpcMethodsClientFuncParams`
|
|
677
|
+
[`RpcMethodsClientFuncParams`](../interfaces/RpcMethodsClientFuncParams.md)
|
|
663
678
|
|
|
664
679
|
#### Returns
|
|
665
680
|
|
|
@@ -675,7 +690,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-client-tool.ts:19](
|
|
|
675
690
|
|
|
676
691
|
> **arr2ObjParams**(`params`): `any`[]
|
|
677
692
|
|
|
678
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:629](https://github.com/isdk/ai-tool.js/blob/
|
|
693
|
+
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)
|
|
679
694
|
|
|
680
695
|
Converts an array of positional arguments into a named parameters object.
|
|
681
696
|
This is used internally to support functions defined with named parameters.
|
|
@@ -736,7 +751,7 @@ this object
|
|
|
736
751
|
|
|
737
752
|
> **assignMethods**(`methods`): `void`
|
|
738
753
|
|
|
739
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-client-tool.ts:32](https://github.com/isdk/ai-tool.js/blob/
|
|
754
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-client-tool.ts:32](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/rpc-methods-client-tool.ts#L32)
|
|
740
755
|
|
|
741
756
|
#### Parameters
|
|
742
757
|
|
|
@@ -950,7 +965,7 @@ the new dest object
|
|
|
950
965
|
|
|
951
966
|
> **close**(): `void`
|
|
952
967
|
|
|
953
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:177](https://github.com/isdk/ai-tool.js/blob/
|
|
968
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:177](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/funcs/event-client.ts#L177)
|
|
954
969
|
|
|
955
970
|
#### Returns
|
|
956
971
|
|
|
@@ -988,7 +1003,7 @@ the defined attributes of the object
|
|
|
988
1003
|
|
|
989
1004
|
> `optional` **delete**(`__namedParameters`): `any`
|
|
990
1005
|
|
|
991
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:13](https://github.com/isdk/ai-tool.js/blob/
|
|
1006
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:13](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/res-client-tools.ts#L13)
|
|
992
1007
|
|
|
993
1008
|
#### Parameters
|
|
994
1009
|
|
|
@@ -1010,7 +1025,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:13](https:/
|
|
|
1010
1025
|
|
|
1011
1026
|
> **esListener**(`evtType`, `data`, `ctx`?): `void`
|
|
1012
1027
|
|
|
1013
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:72](https://github.com/isdk/ai-tool.js/blob/
|
|
1028
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:72](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/funcs/event-client.ts#L72)
|
|
1014
1029
|
|
|
1015
1030
|
#### Parameters
|
|
1016
1031
|
|
|
@@ -1068,7 +1083,7 @@ the dest object.
|
|
|
1068
1083
|
|
|
1069
1084
|
> **fetch**(`options`, `action`): `Promise`\<`any`\>
|
|
1070
1085
|
|
|
1071
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:18](https://github.com/isdk/ai-tool.js/blob/
|
|
1086
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:18](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/res-client-tools.ts#L18)
|
|
1072
1087
|
|
|
1073
1088
|
#### Parameters
|
|
1074
1089
|
|
|
@@ -1094,7 +1109,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:18](https:/
|
|
|
1094
1109
|
|
|
1095
1110
|
> **forwardEvent**(`events`): `void`
|
|
1096
1111
|
|
|
1097
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:138](https://github.com/isdk/ai-tool.js/blob/
|
|
1112
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:138](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/funcs/event-client.ts#L138)
|
|
1098
1113
|
|
|
1099
1114
|
forward local event(s) to server
|
|
1100
1115
|
|
|
@@ -1118,7 +1133,7 @@ Note: pls backendEventable(ClientTools or EventClient) first
|
|
|
1118
1133
|
|
|
1119
1134
|
> **func**(`options`): `Promise`\<`any`\>
|
|
1120
1135
|
|
|
1121
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-client-tool.ts:24](https://github.com/isdk/ai-tool.js/blob/
|
|
1136
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-client-tool.ts:24](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/rpc-methods-client-tool.ts#L24)
|
|
1122
1137
|
|
|
1123
1138
|
The core implementation for a client-side tool. When a `ClientTools` instance
|
|
1124
1139
|
is "run", this `func` method is executed. It delegates the call to the
|
|
@@ -1128,7 +1143,7 @@ configured transport, which handles the network communication.
|
|
|
1128
1143
|
|
|
1129
1144
|
##### options
|
|
1130
1145
|
|
|
1131
|
-
`RpcMethodsClientFuncParams`
|
|
1146
|
+
[`RpcMethodsClientFuncParams`](../interfaces/RpcMethodsClientFuncParams.md)
|
|
1132
1147
|
|
|
1133
1148
|
#### Returns
|
|
1134
1149
|
|
|
@@ -1146,7 +1161,7 @@ The result from the remote tool.
|
|
|
1146
1161
|
|
|
1147
1162
|
> `optional` **get**(`__namedParameters`): `any`
|
|
1148
1163
|
|
|
1149
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/
|
|
1164
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/res-client-tools.ts#L10)
|
|
1150
1165
|
|
|
1151
1166
|
#### Parameters
|
|
1152
1167
|
|
|
@@ -1168,7 +1183,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:10](https:/
|
|
|
1168
1183
|
|
|
1169
1184
|
> **getFunc**(`name`?): `any`
|
|
1170
1185
|
|
|
1171
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:720](https://github.com/isdk/ai-tool.js/blob/
|
|
1186
|
+
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)
|
|
1172
1187
|
|
|
1173
1188
|
Gets a bound function reference for execution with named parameters.
|
|
1174
1189
|
If a name is provided, it retrieves a different function from the registry.
|
|
@@ -1198,7 +1213,7 @@ A function reference or `undefined` if not found.
|
|
|
1198
1213
|
|
|
1199
1214
|
> **getFuncWithPos**(`name`?): `any`
|
|
1200
1215
|
|
|
1201
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:777](https://github.com/isdk/ai-tool.js/blob/
|
|
1216
|
+
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)
|
|
1202
1217
|
|
|
1203
1218
|
Gets a bound function reference suitable for positional argument execution.
|
|
1204
1219
|
If a name is provided, it retrieves a different function from the registry.
|
|
@@ -1248,7 +1263,7 @@ the descriptors of properties object
|
|
|
1248
1263
|
|
|
1249
1264
|
> **hasAsyncFeature**(`feature`): `boolean`
|
|
1250
1265
|
|
|
1251
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:787](https://github.com/isdk/ai-tool.js/blob/
|
|
1266
|
+
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)
|
|
1252
1267
|
|
|
1253
1268
|
Checks if the current function instance supports a specific async feature.
|
|
1254
1269
|
|
|
@@ -1302,7 +1317,7 @@ A property name.
|
|
|
1302
1317
|
|
|
1303
1318
|
> **init**(`events`): `Promise`\<`any`\>
|
|
1304
1319
|
|
|
1305
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:170](https://github.com/isdk/ai-tool.js/blob/
|
|
1320
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:170](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/funcs/event-client.ts#L170)
|
|
1306
1321
|
|
|
1307
1322
|
#### Parameters
|
|
1308
1323
|
|
|
@@ -1320,7 +1335,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:170](http
|
|
|
1320
1335
|
|
|
1321
1336
|
> **initEventStream**(`events`?): [`PubSubClientStream`](../interfaces/PubSubClientStream.md)
|
|
1322
1337
|
|
|
1323
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:51](https://github.com/isdk/ai-tool.js/blob/
|
|
1338
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:51](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/funcs/event-client.ts#L51)
|
|
1324
1339
|
|
|
1325
1340
|
#### Parameters
|
|
1326
1341
|
|
|
@@ -1420,7 +1435,7 @@ The source object
|
|
|
1420
1435
|
|
|
1421
1436
|
> **isStream**(`params`): `undefined` \| `boolean`
|
|
1422
1437
|
|
|
1423
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:805](https://github.com/isdk/ai-tool.js/blob/
|
|
1438
|
+
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)
|
|
1424
1439
|
|
|
1425
1440
|
Determines if a function call should produce a stream.
|
|
1426
1441
|
|
|
@@ -1454,7 +1469,7 @@ The runtime parameters passed to the function call.
|
|
|
1454
1469
|
|
|
1455
1470
|
> `optional` **list**(`options`?): `any`
|
|
1456
1471
|
|
|
1457
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:14](https://github.com/isdk/ai-tool.js/blob/
|
|
1472
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:14](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/res-client-tools.ts#L14)
|
|
1458
1473
|
|
|
1459
1474
|
#### Parameters
|
|
1460
1475
|
|
|
@@ -1508,7 +1523,7 @@ the dest object.
|
|
|
1508
1523
|
|
|
1509
1524
|
> **obj2ArrParams**(`params`?): `any`[]
|
|
1510
1525
|
|
|
1511
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:648](https://github.com/isdk/ai-tool.js/blob/
|
|
1526
|
+
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)
|
|
1512
1527
|
|
|
1513
1528
|
Converts a named parameters object into an array of positional arguments.
|
|
1514
1529
|
This is used for functions defined with positional parameters.
|
|
@@ -1537,7 +1552,7 @@ An array of positional arguments.
|
|
|
1537
1552
|
|
|
1538
1553
|
> `optional` **post**(`options`): `any`
|
|
1539
1554
|
|
|
1540
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:11](https://github.com/isdk/ai-tool.js/blob/
|
|
1555
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:11](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/res-client-tools.ts#L11)
|
|
1541
1556
|
|
|
1542
1557
|
#### Parameters
|
|
1543
1558
|
|
|
@@ -1585,7 +1600,7 @@ A property name.
|
|
|
1585
1600
|
|
|
1586
1601
|
> `optional` **put**(`__namedParameters`): `any`
|
|
1587
1602
|
|
|
1588
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:12](https://github.com/isdk/ai-tool.js/blob/
|
|
1603
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:12](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/res-client-tools.ts#L12)
|
|
1589
1604
|
|
|
1590
1605
|
#### Parameters
|
|
1591
1606
|
|
|
@@ -1607,7 +1622,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:12](https:/
|
|
|
1607
1622
|
|
|
1608
1623
|
> **register**(): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
1609
1624
|
|
|
1610
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:602](https://github.com/isdk/ai-tool.js/blob/
|
|
1625
|
+
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)
|
|
1611
1626
|
|
|
1612
1627
|
Registers the current `ToolFunc` instance into the static registry.
|
|
1613
1628
|
Also registers any declared dependencies.
|
|
@@ -1628,7 +1643,7 @@ The instance itself upon successful registration, or `false` if it already exist
|
|
|
1628
1643
|
|
|
1629
1644
|
> **run**(`params`?): `Promise`\<`any`\>
|
|
1630
1645
|
|
|
1631
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:686](https://github.com/isdk/ai-tool.js/blob/
|
|
1646
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:686](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L686)
|
|
1632
1647
|
|
|
1633
1648
|
Executes the function asynchronously with a named parameters object.
|
|
1634
1649
|
|
|
@@ -1656,7 +1671,7 @@ A promise that resolves with the function's result.
|
|
|
1656
1671
|
|
|
1657
1672
|
> **runAs**(`name`, `params`?): `Promise`\<`any`\>
|
|
1658
1673
|
|
|
1659
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:697](https://github.com/isdk/ai-tool.js/blob/
|
|
1674
|
+
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)
|
|
1660
1675
|
|
|
1661
1676
|
Asynchronously executes another registered function by name.
|
|
1662
1677
|
This method delegates to `runAsSync()` internally.
|
|
@@ -1691,7 +1706,7 @@ A promise that resolves with the result of the function execution.
|
|
|
1691
1706
|
|
|
1692
1707
|
> **runAsSync**(`name`, `params`?): `any`
|
|
1693
1708
|
|
|
1694
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:708](https://github.com/isdk/ai-tool.js/blob/
|
|
1709
|
+
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)
|
|
1695
1710
|
|
|
1696
1711
|
Synchronously executes another registered function by name.
|
|
1697
1712
|
This is a convenience method that forwards the call to the static `runSync()` method.
|
|
@@ -1726,7 +1741,7 @@ The result of the function execution.
|
|
|
1726
1741
|
|
|
1727
1742
|
> **runSync**(`params`?): `any`
|
|
1728
1743
|
|
|
1729
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:667](https://github.com/isdk/ai-tool.js/blob/
|
|
1744
|
+
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)
|
|
1730
1745
|
|
|
1731
1746
|
Executes the function synchronously with a named parameters object.
|
|
1732
1747
|
|
|
@@ -1758,7 +1773,7 @@ Will throw an error if an array of parameters is passed to a function that expec
|
|
|
1758
1773
|
|
|
1759
1774
|
> **runWithPos**(...`params`): `Promise`\<`any`\>
|
|
1760
1775
|
|
|
1761
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:755](https://github.com/isdk/ai-tool.js/blob/
|
|
1776
|
+
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)
|
|
1762
1777
|
|
|
1763
1778
|
Executes the function asynchronously using positional arguments.
|
|
1764
1779
|
Delegates to `runWithPosSync()` internally.
|
|
@@ -1787,7 +1802,7 @@ A promise that resolves with the result of the function execution.
|
|
|
1787
1802
|
|
|
1788
1803
|
> **runWithPosAs**(`name`, ...`params`): `Promise`\<`any`\>
|
|
1789
1804
|
|
|
1790
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:766](https://github.com/isdk/ai-tool.js/blob/
|
|
1805
|
+
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)
|
|
1791
1806
|
|
|
1792
1807
|
Asynchronously executes another function by name using positional arguments.
|
|
1793
1808
|
Delegates to `runWithPosAsSync()` internally.
|
|
@@ -1822,7 +1837,7 @@ A promise that resolves with the result of the function execution.
|
|
|
1822
1837
|
|
|
1823
1838
|
> **runWithPosAsSync**(`name`, ...`params`): `any`
|
|
1824
1839
|
|
|
1825
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:745](https://github.com/isdk/ai-tool.js/blob/
|
|
1840
|
+
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)
|
|
1826
1841
|
|
|
1827
1842
|
Synchronously executes another function by name using positional arguments.
|
|
1828
1843
|
This is a convenience wrapper around the static `runWithPosSync()` method.
|
|
@@ -1857,7 +1872,7 @@ The result of the function execution.
|
|
|
1857
1872
|
|
|
1858
1873
|
> **runWithPosSync**(...`params`): `any`
|
|
1859
1874
|
|
|
1860
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:731](https://github.com/isdk/ai-tool.js/blob/
|
|
1875
|
+
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)
|
|
1861
1876
|
|
|
1862
1877
|
Executes the function synchronously using positional arguments.
|
|
1863
1878
|
If the function expects named parameters, it converts the arguments automatically.
|
|
@@ -1886,7 +1901,7 @@ The result of the function execution.
|
|
|
1886
1901
|
|
|
1887
1902
|
> **subscribe**(`events`): `Promise`\<`any`\>
|
|
1888
1903
|
|
|
1889
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:95](https://github.com/isdk/ai-tool.js/blob/
|
|
1904
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:95](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/funcs/event-client.ts#L95)
|
|
1890
1905
|
|
|
1891
1906
|
subscribe server sent event(SSE)
|
|
1892
1907
|
|
|
@@ -1984,7 +1999,7 @@ Returns a string representation of an object.
|
|
|
1984
1999
|
|
|
1985
2000
|
> **unforwardEvent**(`events`): `void`
|
|
1986
2001
|
|
|
1987
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:158](https://github.com/isdk/ai-tool.js/blob/
|
|
2002
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:158](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/funcs/event-client.ts#L158)
|
|
1988
2003
|
|
|
1989
2004
|
unforward local event(s) to server
|
|
1990
2005
|
|
|
@@ -2008,7 +2023,7 @@ Note: pls backendEventable(ClientTools or EventClient) first
|
|
|
2008
2023
|
|
|
2009
2024
|
> **unregister**(): `any`
|
|
2010
2025
|
|
|
2011
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:619](https://github.com/isdk/ai-tool.js/blob/
|
|
2026
|
+
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)
|
|
2012
2027
|
|
|
2013
2028
|
Removes the current `ToolFunc` instance from the static registry.
|
|
2014
2029
|
|
|
@@ -2028,7 +2043,7 @@ The instance that was unregistered.
|
|
|
2028
2043
|
|
|
2029
2044
|
> **unsubscribe**(`events`): `Promise`\<`any`\>
|
|
2030
2045
|
|
|
2031
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:114](https://github.com/isdk/ai-tool.js/blob/
|
|
2046
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:114](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/funcs/event-client.ts#L114)
|
|
2032
2047
|
|
|
2033
2048
|
unsubscribe server sent event(SSE)
|
|
2034
2049
|
|
|
@@ -2422,7 +2437,7 @@ Object that contains the properties and methods. This can be an object that you
|
|
|
2422
2437
|
|
|
2423
2438
|
> `static` **fetch**(`name`, `objParam`?, ...`args`?): `Promise`\<`any`\>
|
|
2424
2439
|
|
|
2425
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:98](https://github.com/isdk/ai-tool.js/blob/
|
|
2440
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:98](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/client-tools.ts#L98)
|
|
2426
2441
|
|
|
2427
2442
|
#### Parameters
|
|
2428
2443
|
|
|
@@ -2598,7 +2613,7 @@ An iterable object that contains key-value entries for properties and methods.
|
|
|
2598
2613
|
|
|
2599
2614
|
> `static` **get**(`name`): [`ToolFunc`](ToolFunc.md)
|
|
2600
2615
|
|
|
2601
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:319](https://github.com/isdk/ai-tool.js/blob/
|
|
2616
|
+
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)
|
|
2602
2617
|
|
|
2603
2618
|
Retrieves a registered function by its name or alias.
|
|
2604
2619
|
|
|
@@ -2626,7 +2641,7 @@ The `ToolFunc` instance if found, otherwise `undefined`.
|
|
|
2626
2641
|
|
|
2627
2642
|
> `static` **getAllByTag**(`tagName`): [`ToolFunc`](ToolFunc.md)[]
|
|
2628
2643
|
|
|
2629
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:365](https://github.com/isdk/ai-tool.js/blob/
|
|
2644
|
+
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)
|
|
2630
2645
|
|
|
2631
2646
|
Retrieves all registered functions that have a specific tag.
|
|
2632
2647
|
|
|
@@ -2654,7 +2669,7 @@ An array of matching `ToolFunc` instances.
|
|
|
2654
2669
|
|
|
2655
2670
|
> `static` **getByTag**(`tagName`): `undefined` \| [`ToolFunc`](ToolFunc.md)
|
|
2656
2671
|
|
|
2657
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:340](https://github.com/isdk/ai-tool.js/blob/
|
|
2672
|
+
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)
|
|
2658
2673
|
|
|
2659
2674
|
Finds the first registered function that has a specific tag.
|
|
2660
2675
|
|
|
@@ -2682,7 +2697,7 @@ The first matching `ToolFunc` instance, or `undefined` if none is found.
|
|
|
2682
2697
|
|
|
2683
2698
|
> `static` **getFunc**(`name`): `any`
|
|
2684
2699
|
|
|
2685
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:431](https://github.com/isdk/ai-tool.js/blob/
|
|
2700
|
+
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)
|
|
2686
2701
|
|
|
2687
2702
|
Retrieves a bound, runnable function reference for a registered function.
|
|
2688
2703
|
This reference is suitable for execution with an object of named parameters.
|
|
@@ -2711,7 +2726,7 @@ A bound function reference, or `undefined` if not found.
|
|
|
2711
2726
|
|
|
2712
2727
|
> `static` **getFuncWithPos**(`name`): `any`
|
|
2713
2728
|
|
|
2714
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:472](https://github.com/isdk/ai-tool.js/blob/
|
|
2729
|
+
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)
|
|
2715
2730
|
|
|
2716
2731
|
Retrieves a bound, runnable function reference for a registered function.
|
|
2717
2732
|
This reference is suitable for execution with positional arguments.
|
|
@@ -2900,7 +2915,7 @@ The object that references the prototype.
|
|
|
2900
2915
|
|
|
2901
2916
|
> `static` **hasAsyncFeature**(`feature`): `boolean`
|
|
2902
2917
|
|
|
2903
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:388](https://github.com/isdk/ai-tool.js/blob/
|
|
2918
|
+
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)
|
|
2904
2919
|
|
|
2905
2920
|
Checks if any registered function has a specific asynchronous feature.
|
|
2906
2921
|
|
|
@@ -3120,7 +3135,7 @@ Object that contains the properties and methods. This can be an object that you
|
|
|
3120
3135
|
|
|
3121
3136
|
> `static` **list**(): [`Funcs`](../interfaces/Funcs.md)
|
|
3122
3137
|
|
|
3123
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:331](https://github.com/isdk/ai-tool.js/blob/
|
|
3138
|
+
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)
|
|
3124
3139
|
|
|
3125
3140
|
Returns the complete map of all registered functions.
|
|
3126
3141
|
|
|
@@ -3140,7 +3155,7 @@ The map of `ToolFunc` instances.
|
|
|
3140
3155
|
|
|
3141
3156
|
> `static` **loadFrom**(`items`?): `Promise`\<[`Funcs`](../interfaces/Funcs.md)\>
|
|
3142
3157
|
|
|
3143
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:68](https://github.com/isdk/ai-tool.js/blob/
|
|
3158
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:68](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/client-tools.ts#L68)
|
|
3144
3159
|
|
|
3145
3160
|
Loads tool definitions from the remote server via the configured transport.
|
|
3146
3161
|
This method populates the local `ToolFunc` registry with `ClientTools` stubs.
|
|
@@ -3165,7 +3180,7 @@ This method populates the local `ToolFunc` registry with `ClientTools` stubs.
|
|
|
3165
3180
|
|
|
3166
3181
|
> `static` **loadFromSync**(`items`): `void`
|
|
3167
3182
|
|
|
3168
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:84](https://github.com/isdk/ai-tool.js/blob/
|
|
3183
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:84](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/client-tools.ts#L84)
|
|
3169
3184
|
|
|
3170
3185
|
Synchronously loads tool definitions from a provided object, registering
|
|
3171
3186
|
each one as a `ClientTools` instance.
|
|
@@ -3224,7 +3239,7 @@ Object to make non-extensible.
|
|
|
3224
3239
|
|
|
3225
3240
|
> `static` **register**(`name`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
3226
3241
|
|
|
3227
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:495](https://github.com/isdk/ai-tool.js/blob/
|
|
3242
|
+
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)
|
|
3228
3243
|
|
|
3229
3244
|
Registers a new tool function.
|
|
3230
3245
|
|
|
@@ -3260,7 +3275,7 @@ The new `ToolFunc` instance, or `false` if a function with that name already exi
|
|
|
3260
3275
|
|
|
3261
3276
|
> `static` **register**(`func`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
3262
3277
|
|
|
3263
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:496](https://github.com/isdk/ai-tool.js/blob/
|
|
3278
|
+
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)
|
|
3264
3279
|
|
|
3265
3280
|
Registers a new tool function.
|
|
3266
3281
|
|
|
@@ -3296,7 +3311,7 @@ The new `ToolFunc` instance, or `false` if a function with that name already exi
|
|
|
3296
3311
|
|
|
3297
3312
|
> `static` **register**(`name`, `options`?): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
3298
3313
|
|
|
3299
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:497](https://github.com/isdk/ai-tool.js/blob/
|
|
3314
|
+
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)
|
|
3300
3315
|
|
|
3301
3316
|
Registers a new tool function.
|
|
3302
3317
|
|
|
@@ -3334,7 +3349,7 @@ The new `ToolFunc` instance, or `false` if a function with that name already exi
|
|
|
3334
3349
|
|
|
3335
3350
|
> `static` **run**(`name`, `params`?): `Promise`\<`any`\>
|
|
3336
3351
|
|
|
3337
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:402](https://github.com/isdk/ai-tool.js/blob/
|
|
3352
|
+
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)
|
|
3338
3353
|
|
|
3339
3354
|
Asynchronously executes a registered function by name with named parameters.
|
|
3340
3355
|
|
|
@@ -3372,7 +3387,7 @@ If the function with the given name is not found.
|
|
|
3372
3387
|
|
|
3373
3388
|
> `static` **runSync**(`name`, `params`?): `any`
|
|
3374
3389
|
|
|
3375
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:417](https://github.com/isdk/ai-tool.js/blob/
|
|
3390
|
+
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)
|
|
3376
3391
|
|
|
3377
3392
|
Synchronously executes a registered function by name with named parameters.
|
|
3378
3393
|
|
|
@@ -3410,7 +3425,7 @@ If the function with the given name is not found.
|
|
|
3410
3425
|
|
|
3411
3426
|
> `static` **runWithPos**(`name`, ...`params`): `Promise`\<`any`\>
|
|
3412
3427
|
|
|
3413
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:443](https://github.com/isdk/ai-tool.js/blob/
|
|
3428
|
+
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)
|
|
3414
3429
|
|
|
3415
3430
|
Asynchronously executes a function using positional arguments.
|
|
3416
3431
|
|
|
@@ -3448,7 +3463,7 @@ If the function with the given name is not found.
|
|
|
3448
3463
|
|
|
3449
3464
|
> `static` **runWithPosSync**(`name`, ...`params`): `any`
|
|
3450
3465
|
|
|
3451
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:458](https://github.com/isdk/ai-tool.js/blob/
|
|
3466
|
+
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)
|
|
3452
3467
|
|
|
3453
3468
|
Synchronously executes a function using positional arguments.
|
|
3454
3469
|
|
|
@@ -3548,7 +3563,7 @@ The value of the new prototype or null.
|
|
|
3548
3563
|
|
|
3549
3564
|
> `static` **setPubSubTransport**(`t`?): `void`
|
|
3550
3565
|
|
|
3551
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:15](https://github.com/isdk/ai-tool.js/blob/
|
|
3566
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:15](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/funcs/event-client.ts#L15)
|
|
3552
3567
|
|
|
3553
3568
|
#### Parameters
|
|
3554
3569
|
|
|
@@ -3566,7 +3581,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:15](https
|
|
|
3566
3581
|
|
|
3567
3582
|
> `static` **setTransport**(`transport`): `void`
|
|
3568
3583
|
|
|
3569
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:50](https://github.com/isdk/ai-tool.js/blob/
|
|
3584
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:50](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/client-tools.ts#L50)
|
|
3570
3585
|
|
|
3571
3586
|
Injects the client-side transport implementation. This is a crucial step
|
|
3572
3587
|
to enable communication with the server.
|
|
@@ -3593,7 +3608,7 @@ The transport instance to use for all client-server communication.
|
|
|
3593
3608
|
|
|
3594
3609
|
> `static` **unregister**(`name`): `undefined` \| [`ToolFunc`](ToolFunc.md)
|
|
3595
3610
|
|
|
3596
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:547](https://github.com/isdk/ai-tool.js/blob/
|
|
3611
|
+
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)
|
|
3597
3612
|
|
|
3598
3613
|
Unregisters a function by its name, also removing any associated aliases.
|
|
3599
3614
|
|