@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: BinarySemaphore
|
|
8
8
|
|
|
9
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:88](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:88](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-semaphore.ts#L88)
|
|
10
10
|
|
|
11
11
|
A binary semaphore implementation for managing concurrency in asynchronous operations.
|
|
12
12
|
Unlike a general semaphore, a binary semaphore allows only one caller to acquire the semaphore at a time.
|
|
@@ -47,7 +47,7 @@ const data = await Promise.all(array.map(fetchData));
|
|
|
47
47
|
|
|
48
48
|
> **new BinarySemaphore**(`options`): [`BinarySemaphore`](BinarySemaphore.md)
|
|
49
49
|
|
|
50
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:145](https://github.com/isdk/ai-tool.js/blob/
|
|
50
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:145](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-semaphore.ts#L145)
|
|
51
51
|
|
|
52
52
|
Creates a binary semaphore object for managing concurrency in asynchronous operations.
|
|
53
53
|
|
|
@@ -67,7 +67,7 @@ Creates a binary semaphore object for managing concurrency in asynchronous opera
|
|
|
67
67
|
|
|
68
68
|
> `protected` **\_activeCount**: `number`
|
|
69
69
|
|
|
70
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:97](https://github.com/isdk/ai-tool.js/blob/
|
|
70
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:97](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-semaphore.ts#L97)
|
|
71
71
|
|
|
72
72
|
***
|
|
73
73
|
|
|
@@ -75,7 +75,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:97](ht
|
|
|
75
75
|
|
|
76
76
|
> `protected` **emitter**: [`EventEmitter`](EventEmitter.md)
|
|
77
77
|
|
|
78
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:91](https://github.com/isdk/ai-tool.js/blob/
|
|
78
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:91](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-semaphore.ts#L91)
|
|
79
79
|
|
|
80
80
|
***
|
|
81
81
|
|
|
@@ -83,7 +83,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:91](ht
|
|
|
83
83
|
|
|
84
84
|
> `protected` **free**: `any`
|
|
85
85
|
|
|
86
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:90](https://github.com/isdk/ai-tool.js/blob/
|
|
86
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:90](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-semaphore.ts#L90)
|
|
87
87
|
|
|
88
88
|
***
|
|
89
89
|
|
|
@@ -91,7 +91,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:90](ht
|
|
|
91
91
|
|
|
92
92
|
> `protected` **initTokenFn**: (`token`?) => `void`
|
|
93
93
|
|
|
94
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:95](https://github.com/isdk/ai-tool.js/blob/
|
|
94
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:95](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-semaphore.ts#L95)
|
|
95
95
|
|
|
96
96
|
#### Parameters
|
|
97
97
|
|
|
@@ -109,7 +109,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:95](ht
|
|
|
109
109
|
|
|
110
110
|
> `protected` **paused**: `boolean`
|
|
111
111
|
|
|
112
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:96](https://github.com/isdk/ai-tool.js/blob/
|
|
112
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:96](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-semaphore.ts#L96)
|
|
113
113
|
|
|
114
114
|
***
|
|
115
115
|
|
|
@@ -117,7 +117,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:96](ht
|
|
|
117
117
|
|
|
118
118
|
> `protected` `optional` **pauseFn**: () => `void`
|
|
119
119
|
|
|
120
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:93](https://github.com/isdk/ai-tool.js/blob/
|
|
120
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:93](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-semaphore.ts#L93)
|
|
121
121
|
|
|
122
122
|
#### Returns
|
|
123
123
|
|
|
@@ -129,7 +129,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:93](ht
|
|
|
129
129
|
|
|
130
130
|
> `protected` `optional` **resumeFn**: () => `void`
|
|
131
131
|
|
|
132
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:94](https://github.com/isdk/ai-tool.js/blob/
|
|
132
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:94](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-semaphore.ts#L94)
|
|
133
133
|
|
|
134
134
|
#### Returns
|
|
135
135
|
|
|
@@ -141,7 +141,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:94](ht
|
|
|
141
141
|
|
|
142
142
|
> `protected` **useDefaultTokens**: `boolean`
|
|
143
143
|
|
|
144
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:92](https://github.com/isdk/ai-tool.js/blob/
|
|
144
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:92](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-semaphore.ts#L92)
|
|
145
145
|
|
|
146
146
|
***
|
|
147
147
|
|
|
@@ -149,7 +149,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:92](ht
|
|
|
149
149
|
|
|
150
150
|
> `readonly` **waiting**: `Deque`\<`undefined` \| [`SemaphoreTaskItem`](../interfaces/SemaphoreTaskItem.md)\>
|
|
151
151
|
|
|
152
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:89](https://github.com/isdk/ai-tool.js/blob/
|
|
152
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:89](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-semaphore.ts#L89)
|
|
153
153
|
|
|
154
154
|
## Accessors
|
|
155
155
|
|
|
@@ -159,7 +159,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:89](ht
|
|
|
159
159
|
|
|
160
160
|
> **get** **activeCount**(): `number`
|
|
161
161
|
|
|
162
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:318](https://github.com/isdk/ai-tool.js/blob/
|
|
162
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:318](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-semaphore.ts#L318)
|
|
163
163
|
|
|
164
164
|
Get the total count of all active operations.
|
|
165
165
|
|
|
@@ -181,7 +181,7 @@ The total count of active operations, including both waiting and ongoing tasks.
|
|
|
181
181
|
|
|
182
182
|
> **get** **pendingCount**(): `number`
|
|
183
183
|
|
|
184
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:327](https://github.com/isdk/ai-tool.js/blob/
|
|
184
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:327](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-semaphore.ts#L327)
|
|
185
185
|
|
|
186
186
|
Get the number of callers waiting on the semaphore, i.e. the number of pending promises.
|
|
187
187
|
|
|
@@ -197,7 +197,7 @@ The number of waiters in the waiting list.
|
|
|
197
197
|
|
|
198
198
|
> **\_dispatchTask**(`task`, `options`?): `void`
|
|
199
199
|
|
|
200
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:212](https://github.com/isdk/ai-tool.js/blob/
|
|
200
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:212](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-semaphore.ts#L212)
|
|
201
201
|
|
|
202
202
|
#### Parameters
|
|
203
203
|
|
|
@@ -219,7 +219,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:212](h
|
|
|
219
219
|
|
|
220
220
|
> **\_newReleaser**(`options`?): [`BinarySemaphoreReleaserFunc`](../interfaces/BinarySemaphoreReleaserFunc.md)
|
|
221
221
|
|
|
222
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:199](https://github.com/isdk/ai-tool.js/blob/
|
|
222
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:199](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-semaphore.ts#L199)
|
|
223
223
|
|
|
224
224
|
#### Parameters
|
|
225
225
|
|
|
@@ -237,7 +237,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:199](h
|
|
|
237
237
|
|
|
238
238
|
> **abort**(`reason`?): `void`
|
|
239
239
|
|
|
240
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:301](https://github.com/isdk/ai-tool.js/blob/
|
|
240
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:301](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-semaphore.ts#L301)
|
|
241
241
|
|
|
242
242
|
#### Parameters
|
|
243
243
|
|
|
@@ -255,7 +255,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:301](h
|
|
|
255
255
|
|
|
256
256
|
> **acquire**(`options`?): `Promise`\<[`BinarySemaphoreReleaserFunc`](../interfaces/BinarySemaphoreReleaserFunc.md)\>
|
|
257
257
|
|
|
258
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:243](https://github.com/isdk/ai-tool.js/blob/
|
|
258
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:243](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-semaphore.ts#L243)
|
|
259
259
|
|
|
260
260
|
Acquire a token from the semaphore, thus decrement the number of available execution slots. If initFn is not used then the return value of the function can be discarded.
|
|
261
261
|
|
|
@@ -277,7 +277,7 @@ A promise that resolves to a release function when a token is acquired. If the s
|
|
|
277
277
|
|
|
278
278
|
> **drain**(): `Promise`\<`any`[]\>
|
|
279
279
|
|
|
280
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:296](https://github.com/isdk/ai-tool.js/blob/
|
|
280
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:296](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-semaphore.ts#L296)
|
|
281
281
|
|
|
282
282
|
Drains the semaphore and returns all the initialized tokens in an array. Draining is an ideal way to ensure there are no pending async tasks, for example before a process will terminate.
|
|
283
283
|
|
|
@@ -291,7 +291,7 @@ Drains the semaphore and returns all the initialized tokens in an array. Drainin
|
|
|
291
291
|
|
|
292
292
|
> **init**(`options`): `void`
|
|
293
293
|
|
|
294
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:193](https://github.com/isdk/ai-tool.js/blob/
|
|
294
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:193](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-semaphore.ts#L193)
|
|
295
295
|
|
|
296
296
|
#### Parameters
|
|
297
297
|
|
|
@@ -309,7 +309,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:193](h
|
|
|
309
309
|
|
|
310
310
|
> **initFree**(`options`?): `void`
|
|
311
311
|
|
|
312
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:173](https://github.com/isdk/ai-tool.js/blob/
|
|
312
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:173](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-semaphore.ts#L173)
|
|
313
313
|
|
|
314
314
|
#### Parameters
|
|
315
315
|
|
|
@@ -327,7 +327,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:173](h
|
|
|
327
327
|
|
|
328
328
|
> **lock**(`options`?): `any`
|
|
329
329
|
|
|
330
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:217](https://github.com/isdk/ai-tool.js/blob/
|
|
330
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:217](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-semaphore.ts#L217)
|
|
331
331
|
|
|
332
332
|
#### Parameters
|
|
333
333
|
|
|
@@ -345,7 +345,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:217](h
|
|
|
345
345
|
|
|
346
346
|
> **onReleased**(`options`?): `void`
|
|
347
347
|
|
|
348
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:177](https://github.com/isdk/ai-tool.js/blob/
|
|
348
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:177](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-semaphore.ts#L177)
|
|
349
349
|
|
|
350
350
|
#### Parameters
|
|
351
351
|
|
|
@@ -363,7 +363,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:177](h
|
|
|
363
363
|
|
|
364
364
|
> **release**(`options`?): `void`
|
|
365
365
|
|
|
366
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:288](https://github.com/isdk/ai-tool.js/blob/
|
|
366
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:288](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-semaphore.ts#L288)
|
|
367
367
|
|
|
368
368
|
Releases the semaphore, incrementing the number of free execution slots. If there are tasks in the waiting queue, the next task will be dispatched.
|
|
369
369
|
|
|
@@ -383,7 +383,7 @@ Releases the semaphore, incrementing the number of free execution slots. If ther
|
|
|
383
383
|
|
|
384
384
|
> **tryAcquire**(`options`?): `any`
|
|
385
385
|
|
|
386
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:234](https://github.com/isdk/ai-tool.js/blob/
|
|
386
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:234](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-semaphore.ts#L234)
|
|
387
387
|
|
|
388
388
|
Attempt to acquire a token from the semaphore, if one is available immediately. Otherwise, return undefined.
|
|
389
389
|
|
|
@@ -405,7 +405,7 @@ Returns a token if the semaphore is not full; otherwise, returns `undefined`.
|
|
|
405
405
|
|
|
406
406
|
> **unlock**(`token`?): `void`
|
|
407
407
|
|
|
408
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:225](https://github.com/isdk/ai-tool.js/blob/
|
|
408
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:225](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-semaphore.ts#L225)
|
|
409
409
|
|
|
410
410
|
#### Parameters
|
|
411
411
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: CancelableAbility
|
|
8
8
|
|
|
9
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:74](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:74](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L74)
|
|
10
10
|
|
|
11
11
|
## Indexable
|
|
12
12
|
|
|
@@ -28,7 +28,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:74]
|
|
|
28
28
|
|
|
29
29
|
> **\_\_task\_aborter**: `undefined` \| [`TaskAbortController`](TaskAbortController.md) \| [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md)
|
|
30
30
|
|
|
31
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:86](https://github.com/isdk/ai-tool.js/blob/
|
|
31
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:86](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L86)
|
|
32
32
|
|
|
33
33
|
***
|
|
34
34
|
|
|
@@ -36,7 +36,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:86]
|
|
|
36
36
|
|
|
37
37
|
> **\_\_task\_semaphore**: `undefined` \| [`Semaphore`](Semaphore.md)
|
|
38
38
|
|
|
39
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:87](https://github.com/isdk/ai-tool.js/blob/
|
|
39
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:87](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L87)
|
|
40
40
|
|
|
41
41
|
***
|
|
42
42
|
|
|
@@ -44,7 +44,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:87]
|
|
|
44
44
|
|
|
45
45
|
> `optional` **\_asyncFeatures**: `number`
|
|
46
46
|
|
|
47
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:75](https://github.com/isdk/ai-tool.js/blob/
|
|
47
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:75](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L75)
|
|
48
48
|
|
|
49
49
|
***
|
|
50
50
|
|
|
@@ -52,7 +52,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:75]
|
|
|
52
52
|
|
|
53
53
|
> `optional` **\_isReadyFn**: [`SemaphoreIsReadyFuncType`](../type-aliases/SemaphoreIsReadyFuncType.md)
|
|
54
54
|
|
|
55
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:77](https://github.com/isdk/ai-tool.js/blob/
|
|
55
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:77](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L77)
|
|
56
56
|
|
|
57
57
|
***
|
|
58
58
|
|
|
@@ -60,7 +60,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:77]
|
|
|
60
60
|
|
|
61
61
|
> **\_maxTaskConcurrency**: `undefined` \| `number`
|
|
62
62
|
|
|
63
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:76](https://github.com/isdk/ai-tool.js/blob/
|
|
63
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:76](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L76)
|
|
64
64
|
|
|
65
65
|
***
|
|
66
66
|
|
|
@@ -68,7 +68,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:76]
|
|
|
68
68
|
|
|
69
69
|
> **cleanMultiTaskAborter**: (`id`, `aborters`) => `void`
|
|
70
70
|
|
|
71
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:84](https://github.com/isdk/ai-tool.js/blob/
|
|
71
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:84](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L84)
|
|
72
72
|
|
|
73
73
|
#### Parameters
|
|
74
74
|
|
|
@@ -90,7 +90,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:84]
|
|
|
90
90
|
|
|
91
91
|
> **generateAsyncTaskId**: (`taskId`?, `aborters`?) => [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
|
|
92
92
|
|
|
93
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:83](https://github.com/isdk/ai-tool.js/blob/
|
|
93
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:83](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L83)
|
|
94
94
|
|
|
95
95
|
#### Parameters
|
|
96
96
|
|
|
@@ -114,7 +114,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:83]
|
|
|
114
114
|
|
|
115
115
|
> **get** **maxTaskConcurrency**(): `undefined` \| `number`
|
|
116
116
|
|
|
117
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:89](https://github.com/isdk/ai-tool.js/blob/
|
|
117
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:89](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L89)
|
|
118
118
|
|
|
119
119
|
##### Returns
|
|
120
120
|
|
|
@@ -128,7 +128,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:89]
|
|
|
128
128
|
|
|
129
129
|
> **get** **semaphore**(): `undefined` \| [`Semaphore`](Semaphore.md)
|
|
130
130
|
|
|
131
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:93](https://github.com/isdk/ai-tool.js/blob/
|
|
131
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:93](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L93)
|
|
132
132
|
|
|
133
133
|
##### Returns
|
|
134
134
|
|
|
@@ -140,7 +140,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:93]
|
|
|
140
140
|
|
|
141
141
|
> **\_cleanMultiTaskAborter**(`id`, `aborters`): `void`
|
|
142
142
|
|
|
143
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:281](https://github.com/isdk/ai-tool.js/blob/
|
|
143
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:281](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L281)
|
|
144
144
|
|
|
145
145
|
#### Parameters
|
|
146
146
|
|
|
@@ -162,7 +162,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:281
|
|
|
162
162
|
|
|
163
163
|
> **\_generateAsyncTaskId**(`taskId`?, `aborters`?): [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
|
|
164
164
|
|
|
165
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:173](https://github.com/isdk/ai-tool.js/blob/
|
|
165
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:173](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L173)
|
|
166
166
|
|
|
167
167
|
#### Parameters
|
|
168
168
|
|
|
@@ -184,7 +184,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:173
|
|
|
184
184
|
|
|
185
185
|
> **$cleanMultiTaskAborter**(`id`, `aborters`): `void`
|
|
186
186
|
|
|
187
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:261](https://github.com/isdk/ai-tool.js/blob/
|
|
187
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:261](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L261)
|
|
188
188
|
|
|
189
189
|
#### Parameters
|
|
190
190
|
|
|
@@ -206,7 +206,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:261
|
|
|
206
206
|
|
|
207
207
|
> **$generateAsyncTaskId**(`taskId`?, `aborters`?): `undefined` \| [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
|
|
208
208
|
|
|
209
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:186](https://github.com/isdk/ai-tool.js/blob/
|
|
209
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:186](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L186)
|
|
210
210
|
|
|
211
211
|
#### Parameters
|
|
212
212
|
|
|
@@ -228,7 +228,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:186
|
|
|
228
228
|
|
|
229
229
|
> **abort**(`reason`?, `data`?): `void`
|
|
230
230
|
|
|
231
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:338](https://github.com/isdk/ai-tool.js/blob/
|
|
231
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:338](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L338)
|
|
232
232
|
|
|
233
233
|
#### Parameters
|
|
234
234
|
|
|
@@ -250,7 +250,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:338
|
|
|
250
250
|
|
|
251
251
|
> **cleanTaskAborter**(`aborter`): `void`
|
|
252
252
|
|
|
253
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:271](https://github.com/isdk/ai-tool.js/blob/
|
|
253
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:271](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L271)
|
|
254
254
|
|
|
255
255
|
#### Parameters
|
|
256
256
|
|
|
@@ -268,7 +268,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:271
|
|
|
268
268
|
|
|
269
269
|
> **createAborter**(`params`?, `taskId`?, `raiseError`?): [`TaskAbortController`](TaskAbortController.md)
|
|
270
270
|
|
|
271
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:197](https://github.com/isdk/ai-tool.js/blob/
|
|
271
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:197](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L197)
|
|
272
272
|
|
|
273
273
|
#### Parameters
|
|
274
274
|
|
|
@@ -294,7 +294,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:197
|
|
|
294
294
|
|
|
295
295
|
> **createTaskPromise**\<`Output`\>(`runTask`, `params`, `options`?): [`TaskPromise`](../interfaces/TaskPromise.md)\<`Output`\>
|
|
296
296
|
|
|
297
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:285](https://github.com/isdk/ai-tool.js/blob/
|
|
297
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:285](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L285)
|
|
298
298
|
|
|
299
299
|
#### Type Parameters
|
|
300
300
|
|
|
@@ -330,7 +330,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:285
|
|
|
330
330
|
|
|
331
331
|
> **getRunningTask**(`taskId`?): `undefined` \| [`TaskAbortController`](TaskAbortController.md)
|
|
332
332
|
|
|
333
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:135](https://github.com/isdk/ai-tool.js/blob/
|
|
333
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:135](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L135)
|
|
334
334
|
|
|
335
335
|
#### Parameters
|
|
336
336
|
|
|
@@ -348,7 +348,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:135
|
|
|
348
348
|
|
|
349
349
|
> **getRunningTaskCount**(): `number`
|
|
350
350
|
|
|
351
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:158](https://github.com/isdk/ai-tool.js/blob/
|
|
351
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:158](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L158)
|
|
352
352
|
|
|
353
353
|
#### Returns
|
|
354
354
|
|
|
@@ -360,7 +360,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:158
|
|
|
360
360
|
|
|
361
361
|
> **getSemaphore**(`isReadyFn`): `undefined` \| [`Semaphore`](Semaphore.md)
|
|
362
362
|
|
|
363
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:97](https://github.com/isdk/ai-tool.js/blob/
|
|
363
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:97](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L97)
|
|
364
364
|
|
|
365
365
|
#### Parameters
|
|
366
366
|
|
|
@@ -378,7 +378,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:97]
|
|
|
378
378
|
|
|
379
379
|
> **hasAsyncFeature**(`feature`): `boolean`
|
|
380
380
|
|
|
381
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:114](https://github.com/isdk/ai-tool.js/blob/
|
|
381
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:114](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L114)
|
|
382
382
|
|
|
383
383
|
#### Parameters
|
|
384
384
|
|
|
@@ -396,7 +396,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:114
|
|
|
396
396
|
|
|
397
397
|
> **isAborted**(`taskId`?): `boolean`
|
|
398
398
|
|
|
399
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:120](https://github.com/isdk/ai-tool.js/blob/
|
|
399
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:120](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L120)
|
|
400
400
|
|
|
401
401
|
#### Parameters
|
|
402
402
|
|
|
@@ -414,7 +414,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:120
|
|
|
414
414
|
|
|
415
415
|
> **runAsyncCancelableTask**\<`Output`\>(`params`, `runTask`, `options`?): [`TaskPromise`](../interfaces/TaskPromise.md)\<`Output`\>
|
|
416
416
|
|
|
417
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:323](https://github.com/isdk/ai-tool.js/blob/
|
|
417
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:323](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L323)
|
|
418
418
|
|
|
419
419
|
#### Type Parameters
|
|
420
420
|
|
|
@@ -454,7 +454,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:323
|
|
|
454
454
|
|
|
455
455
|
> `static` **hasAsyncFeature**(`feature`): `boolean`
|
|
456
456
|
|
|
457
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:107](https://github.com/isdk/ai-tool.js/blob/
|
|
457
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:107](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L107)
|
|
458
458
|
|
|
459
459
|
#### Parameters
|
|
460
460
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: `abstract` ClientToolTransport
|
|
8
8
|
|
|
9
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:36](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:36](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/client.ts#L36)
|
|
10
10
|
|
|
11
11
|
A concrete client transport implementation that uses the browser/node `fetch` API.
|
|
12
12
|
|
|
@@ -28,7 +28,7 @@ A concrete client transport implementation that uses the browser/node `fetch` AP
|
|
|
28
28
|
|
|
29
29
|
> **new ClientToolTransport**(`apiRoot`): [`ClientToolTransport`](ClientToolTransport.md)
|
|
30
30
|
|
|
31
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:41](https://github.com/isdk/ai-tool.js/blob/
|
|
31
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:41](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/client.ts#L41)
|
|
32
32
|
|
|
33
33
|
#### Parameters
|
|
34
34
|
|
|
@@ -50,7 +50,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:41](https:
|
|
|
50
50
|
|
|
51
51
|
> **apiRoot**: `string`
|
|
52
52
|
|
|
53
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:37](https://github.com/isdk/ai-tool.js/blob/
|
|
53
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:37](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/client.ts#L37)
|
|
54
54
|
|
|
55
55
|
The root endpoint for the remote service.
|
|
56
56
|
For HTTP, this is a URL. For IPC, it could be a channel name.
|
|
@@ -69,7 +69,7 @@ For HTTP, this is a URL. For IPC, it could be a channel name.
|
|
|
69
69
|
|
|
70
70
|
> `optional` **options**: `any`
|
|
71
71
|
|
|
72
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:36](https://github.com/isdk/ai-tool.js/blob/
|
|
72
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:36](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/base.ts#L36)
|
|
73
73
|
|
|
74
74
|
Additional options for the transport start or fetch, passed by mount.
|
|
75
75
|
|
|
@@ -87,7 +87,7 @@ Additional options for the transport start or fetch, passed by mount.
|
|
|
87
87
|
|
|
88
88
|
> **Tools**: *typeof* [`ClientTools`](ClientTools.md)
|
|
89
89
|
|
|
90
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:38](https://github.com/isdk/ai-tool.js/blob/
|
|
90
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:38](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/client.ts#L38)
|
|
91
91
|
|
|
92
92
|
#### Implementation of
|
|
93
93
|
|
|
@@ -103,7 +103,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:38](https:
|
|
|
103
103
|
|
|
104
104
|
> `abstract` **\_fetch**(`name`, `args`?, `act`?, `subName`?, `fetchOptions`?): `any`
|
|
105
105
|
|
|
106
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:75](https://github.com/isdk/ai-tool.js/blob/
|
|
106
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:75](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/client.ts#L75)
|
|
107
107
|
|
|
108
108
|
#### Parameters
|
|
109
109
|
|
|
@@ -137,7 +137,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:75](https:
|
|
|
137
137
|
|
|
138
138
|
> **\_mount**(`clientTools`, `apiPrefix`, `options`?): `Promise`\<[`Funcs`](../interfaces/Funcs.md)\>
|
|
139
139
|
|
|
140
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:49](https://github.com/isdk/ai-tool.js/blob/
|
|
140
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:49](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/client.ts#L49)
|
|
141
141
|
|
|
142
142
|
#### Parameters
|
|
143
143
|
|
|
@@ -167,7 +167,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:49](https:
|
|
|
167
167
|
|
|
168
168
|
> **fetch**(`name`, `args`?, `act`?, `subName`?, `fetchOptions`?): `Promise`\<`any`\>
|
|
169
169
|
|
|
170
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:64](https://github.com/isdk/ai-tool.js/blob/
|
|
170
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:64](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/client.ts#L64)
|
|
171
171
|
|
|
172
172
|
Fetches data from the server.
|
|
173
173
|
|
|
@@ -217,7 +217,7 @@ A promise that resolves with the fetched data.
|
|
|
217
217
|
|
|
218
218
|
> **loadApis**(): `Promise`\<[`Funcs`](../interfaces/Funcs.md)\>
|
|
219
219
|
|
|
220
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:58](https://github.com/isdk/ai-tool.js/blob/
|
|
220
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:58](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/client.ts#L58)
|
|
221
221
|
|
|
222
222
|
Connects to the server's discovery endpoint to get the list of available tools.
|
|
223
223
|
|
|
@@ -237,7 +237,7 @@ A promise that resolves to a map of tool function metadata.
|
|
|
237
237
|
|
|
238
238
|
> **mount**(`Tools`, `apiRoot`?, `options`?): `any`
|
|
239
239
|
|
|
240
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:42](https://github.com/isdk/ai-tool.js/blob/
|
|
240
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:42](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/base.ts#L42)
|
|
241
241
|
|
|
242
242
|
#### Parameters
|
|
243
243
|
|
|
@@ -271,7 +271,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:42](https://
|
|
|
271
271
|
|
|
272
272
|
> **setApiRoot**(`apiRoot`): `void`
|
|
273
273
|
|
|
274
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:38](https://github.com/isdk/ai-tool.js/blob/
|
|
274
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:38](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/base.ts#L38)
|
|
275
275
|
|
|
276
276
|
#### Parameters
|
|
277
277
|
|
|
@@ -293,7 +293,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:38](https://
|
|
|
293
293
|
|
|
294
294
|
> `abstract` **toObject**(`res`, `args`?): `any`
|
|
295
295
|
|
|
296
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:76](https://github.com/isdk/ai-tool.js/blob/
|
|
296
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:76](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/client.ts#L76)
|
|
297
297
|
|
|
298
298
|
#### Parameters
|
|
299
299
|
|