@isdk/ai-tool 0.7.0 → 0.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/chunk-4FKBOPZI.mjs +1 -0
- package/dist/{chunk-VIG2GB47.mjs → chunk-TGTHY57V.mjs} +1 -1
- package/dist/funcs.d.mts +1 -2
- package/dist/funcs.d.ts +1 -2
- package/dist/funcs.js +1 -1
- package/dist/funcs.mjs +1 -1
- package/dist/{index-BCco-g_I.d.mts → index-BLW3R7VS.d.mts} +114 -69
- package/dist/{index-BCco-g_I.d.ts → index-BLW3R7VS.d.ts} +114 -69
- package/dist/index.d.mts +101 -38
- package/dist/index.d.ts +101 -38
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/dist/test/util.js +1 -1
- package/dist/test/util.mjs +1 -1
- package/docs/api/{namespaces → @isdk/namespaces}/EventStates/README.md +2 -2
- package/docs/api/{namespaces → @isdk/namespaces}/EventStates/variables/ABORT.md +2 -2
- package/docs/api/{namespaces → @isdk/namespaces}/EventStates/variables/CONTINUE.md +2 -2
- package/docs/api/{namespaces → @isdk/namespaces}/EventStates/variables/DONE.md +2 -2
- package/docs/api/{namespaces → @isdk/namespaces}/EventStates/variables/STOPPED.md +2 -2
- package/docs/api/@isdk/namespaces/uuidv5/README.md +12 -0
- package/docs/api/{namespaces → @isdk/namespaces}/uuidv5/variables/DNS.md +2 -2
- package/docs/api/{namespaces → @isdk/namespaces}/uuidv5/variables/URL.md +2 -2
- package/docs/api/_media/pubsub.md +427 -105
- package/docs/api/_media/server_client_tools.md +5 -3
- package/docs/api/_media/toolFunc.md +3 -1
- package/docs/api/classes/AbortError.md +8 -8
- package/docs/api/classes/AlreadyExistsError.md +8 -8
- package/docs/api/classes/BaseError.md +14 -14
- package/docs/api/classes/BinarySemaphore.md +39 -39
- package/docs/api/classes/CancelableAbility.md +43 -39
- package/docs/api/classes/ClientToolTransport.md +22 -22
- package/docs/api/classes/ClientTools.md +182 -154
- package/docs/api/classes/CommonError.md +12 -12
- package/docs/api/classes/ConfigFile.md +6 -6
- package/docs/api/classes/EnvPromptTemplate.md +14 -14
- package/docs/api/classes/EventClient.md +258 -201
- package/docs/api/classes/EventEmitter.md +14 -14
- package/docs/api/classes/EventServer.md +220 -237
- package/docs/api/classes/EventToolFunc.md +144 -116
- package/docs/api/classes/FStringPromptTemplate.md +14 -14
- package/docs/api/classes/FewShotPromptTemplate.md +30 -26
- package/docs/api/classes/GolangPromptTemplate.md +13 -13
- package/docs/api/classes/HttpClientToolTransport.md +23 -23
- package/docs/api/classes/HttpServerToolTransport.md +40 -27
- package/docs/api/classes/IntSet.md +21 -21
- package/docs/api/classes/LRUCache.md +18 -18
- package/docs/api/classes/NotFoundError.md +8 -8
- package/docs/api/classes/NotImplementationError.md +8 -8
- package/docs/api/classes/PromptExampleSelector.md +17 -15
- package/docs/api/classes/PromptTemplate.md +15 -15
- package/docs/api/classes/ReadableStreamError.md +12 -12
- package/docs/api/classes/ResClientTools.md +658 -143
- package/docs/api/classes/ResServerTools.md +643 -133
- package/docs/api/classes/RpcMethodsClientTool.md +3303 -0
- package/docs/api/classes/RpcMethodsServerTool.md +3248 -0
- package/docs/api/classes/SSEChannel.md +142 -52
- package/docs/api/classes/Semaphore.md +40 -40
- package/docs/api/classes/ServerToolTransport.md +32 -27
- package/docs/api/classes/ServerTools.md +167 -139
- package/docs/api/classes/SignalGate.md +19 -17
- package/docs/api/classes/SseClientPubSubTransport.md +38 -10
- package/docs/api/classes/SseServerPubSubTransport.md +115 -42
- package/docs/api/classes/TaskAbortController.md +13 -13
- package/docs/api/classes/ToolFunc.md +157 -129
- package/docs/api/classes/ToolTransport.md +13 -13
- package/docs/api/classes/YamlTypeBaseObject.md +5 -5
- 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 +2 -2
- package/docs/api/functions/AIStream.md +8 -4
- package/docs/api/functions/ChoiceArgProcessor.md +2 -2
- package/docs/api/functions/DefaultDateFormat.md +2 -2
- package/docs/api/functions/ObjectArgsToArgsInfo.md +1 -1
- package/docs/api/functions/RateLimit.md +2 -2
- package/docs/api/functions/TemplateArgProcessor.md +2 -2
- package/docs/api/functions/addDate.md +7 -3
- package/docs/api/functions/assignDirs.md +1 -1
- package/docs/api/functions/beforeShutdown.md +1 -1
- package/docs/api/functions/calcPerplexity.md +2 -2
- package/docs/api/functions/calcPerplexitySimple.md +1 -1
- package/docs/api/functions/canonicalize.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/createAbilityInjector.md +16 -8
- package/docs/api/functions/createCallbacksTransformer.md +7 -3
- package/docs/api/functions/createEmptyReadableStream.md +1 -1
- package/docs/api/functions/createEndWithRepetitionDetector.md +2 -2
- package/docs/api/functions/createError.md +1 -1
- package/docs/api/functions/createEventStreamTransformer.md +8 -4
- package/docs/api/functions/createHfValueFunc.md +1 -1
- package/docs/api/functions/createLRUCache.md +2 -2
- package/docs/api/functions/createYamlObjectTag.md +1 -1
- package/docs/api/functions/dateToText.md +1 -1
- package/docs/api/functions/decodeCharset.md +2 -2
- package/docs/api/functions/defaultsWithConcat.md +1 -1
- package/docs/api/functions/detectCharset.md +2 -2
- package/docs/api/functions/encodeLLMTokens.md +1 -1
- package/docs/api/functions/ensureQuoted.md +1 -1
- package/docs/api/functions/eventable.md +6 -8
- package/docs/api/functions/expandConfig.md +2 -2
- package/docs/api/functions/expandObjEnv.md +1 -1
- package/docs/api/functions/expandPath.md +2 -2
- package/docs/api/functions/expandPathInObject.md +2 -2
- package/docs/api/functions/expandPaths.md +2 -2
- package/docs/api/functions/fileIsExists.md +1 -1
- package/docs/api/functions/filterValidFnScope.md +2 -2
- package/docs/api/functions/findIndexNonEmptyFrom.md +1 -1
- package/docs/api/functions/findPort.md +1 -1
- package/docs/api/functions/formatISO.md +1 -1
- package/docs/api/functions/formatTextWithSpace.md +2 -2
- package/docs/api/functions/funcGetMeta.md +1 -1
- package/docs/api/functions/funcWithMeta.md +2 -2
- package/docs/api/functions/genUrlParamsStr.md +8 -2
- package/docs/api/functions/getAllEnumKeys.md +4 -2
- package/docs/api/functions/getConfigFileNames.md +2 -2
- package/docs/api/functions/getConfigs.md +2 -2
- package/docs/api/functions/getFileMetaInfo.md +1 -1
- package/docs/api/functions/getHashAlgoBySize.md +1 -1
- package/docs/api/functions/getKeysPath.md +4 -2
- package/docs/api/functions/getLLMTokenizer.md +1 -1
- package/docs/api/functions/getMultiLevelExtname.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 +2 -2
- package/docs/api/functions/getXDGConfigs.md +1 -1
- package/docs/api/functions/hasDirectoryIn.md +2 -2
- package/docs/api/functions/hash.md +1 -1
- package/docs/api/functions/hashFile.md +2 -2
- package/docs/api/functions/hashObject.md +2 -2
- 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 +2 -2
- 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 +2 -2
- 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 +2 -2
- package/docs/api/functions/isWebStream.md +1 -1
- package/docs/api/functions/joinSplitWords.md +1 -1
- package/docs/api/functions/jsonFilterToWhere.md +2 -2
- package/docs/api/functions/jsonToMarkdownStr.md +2 -2
- 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 +2 -2
- package/docs/api/functions/loadTextFromPaths.md +3 -3
- package/docs/api/functions/lrucache.md +1 -1
- package/docs/api/functions/matchUrlProtocol.md +1 -1
- package/docs/api/functions/memoize.md +5 -3
- package/docs/api/functions/mergeArray.md +1 -1
- package/docs/api/functions/messagesToText.md +1 -1
- package/docs/api/functions/nanoid.md +45 -0
- package/docs/api/functions/normalizePath.md +1 -1
- package/docs/api/functions/paramsSizeToScaleStr.md +1 -1
- package/docs/api/functions/parseCommand.md +3 -3
- package/docs/api/functions/parseDateFormat.md +7 -3
- package/docs/api/functions/parseISO.md +7 -3
- package/docs/api/functions/parseJsJson.md +2 -2
- package/docs/api/functions/parseJsJsonSimpleSync.md +2 -2
- package/docs/api/functions/parseObjectArgInfo.md +2 -2
- package/docs/api/functions/parseObjectArgumentInfos.md +2 -2
- package/docs/api/functions/parseObjectArguments.md +2 -2
- package/docs/api/functions/parseObjectArgumentsAsArgInfos.md +2 -2
- package/docs/api/functions/parseYaml.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 +2 -2
- package/docs/api/functions/readTextFileChunks.md +2 -2
- package/docs/api/functions/readTextFileChunksEx.md +2 -2
- package/docs/api/functions/readableFromAsyncIterable.md +4 -2
- package/docs/api/functions/registerCoreTools.md +1 -1
- package/docs/api/functions/removeMarkdownBold.md +2 -2
- package/docs/api/functions/removeMarkdownBoldAndItalic.md +2 -2
- package/docs/api/functions/removeMarkdownItalic.md +2 -2
- package/docs/api/functions/replaceWithPlaceholder.md +2 -2
- package/docs/api/functions/restoreFromPlacehoders.md +2 -2
- package/docs/api/functions/sanitizeFilename.md +1 -1
- package/docs/api/functions/sanitizeFilepath.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 +4 -2
- package/docs/api/functions/splitChunks.md +2 -2
- package/docs/api/functions/splitParagraph.md +2 -2
- package/docs/api/functions/splitSentence.md +1 -1
- package/docs/api/functions/splitWords.md +1 -1
- package/docs/api/functions/stringifyYaml.md +1 -1
- package/docs/api/functions/stripConsoleColor.md +1 -1
- package/docs/api/functions/textToDate.md +1 -1
- package/docs/api/functions/throwError.md +1 -1
- package/docs/api/functions/toDate.md +7 -3
- package/docs/api/functions/toDateTime.md +1 -1
- package/docs/api/functions/trimStartOfStreamHelper.md +3 -3
- package/docs/api/functions/truncTo.md +1 -1
- package/docs/api/functions/truncateByToken.md +2 -2
- package/docs/api/functions/truncateToTokenLimit.md +2 -2
- package/docs/api/functions/truncateToTokenLimitEx.md +2 -2
- package/docs/api/functions/uuid.md +15 -6
- package/docs/api/functions/uuidStringify.md +1 -1
- package/docs/api/functions/uuidv1.md +5 -3
- package/docs/api/functions/uuidv4.md +5 -3
- package/docs/api/functions/uuidv5.md +5 -3
- package/docs/api/functions/uuidv6.md +61 -0
- package/docs/api/functions/uuidv7.md +61 -0
- package/docs/api/functions/wrapEventEmitter.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 +17 -6
- 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 +12 -8
- package/docs/api/interfaces/AIStreamParser.md +8 -6
- package/docs/api/interfaces/AIStreamParserOptions.md +2 -2
- package/docs/api/interfaces/BaseFunc.md +17 -17
- package/docs/api/interfaces/BaseFuncItem.md +15 -15
- 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 +21 -25
- package/docs/api/interfaces/EventClientFuncParams.md +5 -5
- package/docs/api/interfaces/EventServerFuncParams.md +14 -6
- package/docs/api/interfaces/FewShotPromptTemplateOptions.md +9 -7
- package/docs/api/interfaces/FuncItem.md +18 -18
- 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 +9 -9
- package/docs/api/interfaces/IFileMetaInfo.md +8 -8
- package/docs/api/interfaces/IPubSubClientTransport.md +31 -7
- package/docs/api/interfaces/IPubSubServerTransport.md +92 -47
- package/docs/api/interfaces/IReadTextFileChunksOptions.md +13 -13
- package/docs/api/interfaces/IServerToolTransport.md +19 -14
- package/docs/api/interfaces/IToolTransport.md +6 -6
- package/docs/api/interfaces/ITruncateToTokenLimitOptions.md +11 -11
- 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/PubSubClientStream.md +26 -14
- package/docs/api/interfaces/PubSubServerSession.md +8 -8
- package/docs/api/interfaces/RemoteFuncItem.md +21 -25
- 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 +6 -6
- package/docs/api/interfaces/ServerFuncItem.md +22 -26
- package/docs/api/interfaces/ServerFuncParams.md +4 -3
- package/docs/api/interfaces/SplitSentenceOptions.md +5 -5
- package/docs/api/interfaces/StreamCallbacksAndOptions.md +11 -7
- package/docs/api/interfaces/TaskAbortControllers.md +1 -1
- package/docs/api/interfaces/TaskPromise.md +17 -9
- package/docs/api/interfaces/ToolFuncPackage.md +5 -5
- package/docs/api/type-aliases/AIChatContentPart.md +2 -2
- package/docs/api/type-aliases/AIChatMessageParam.md +2 -2
- package/docs/api/type-aliases/AIChatRole.md +2 -2
- package/docs/api/type-aliases/AIChatToolChoiceParam.md +2 -2
- package/docs/api/type-aliases/AIMessageType.md +2 -2
- package/docs/api/type-aliases/AIModelNameRule.md +2 -2
- package/docs/api/type-aliases/AIModelNameRuleFn.md +2 -2
- package/docs/api/type-aliases/AIModelNameRules.md +2 -2
- package/docs/api/type-aliases/AITextGenerationFinishReason.md +2 -2
- package/docs/api/type-aliases/ActionName.md +2 -2
- package/docs/api/type-aliases/ArrayMergeWay.md +2 -2
- package/docs/api/type-aliases/AsyncTaskId.md +2 -2
- package/docs/api/type-aliases/BeforeShutdownListener.md +2 -2
- package/docs/api/type-aliases/EventErrorListenerFn.md +2 -2
- package/docs/api/type-aliases/EventListenerFn.md +2 -2
- package/docs/api/type-aliases/FuncParamType.md +2 -2
- package/docs/api/type-aliases/PromptExamples.md +5 -3
- package/docs/api/type-aliases/PubSubClientId.md +2 -2
- package/docs/api/type-aliases/PubSubCtx.md +24 -4
- package/docs/api/type-aliases/RpcMethodHandler.md +2 -2
- package/docs/api/type-aliases/SSEClient.md +53 -0
- package/docs/api/type-aliases/SemaphoreIsReadyFuncType.md +2 -2
- package/docs/api/type-aliases/TFunc.md +2 -2
- package/docs/api/type-aliases/UUIDVersions.md +11 -0
- 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 +2 -2
- package/docs/api/variables/ArrayMergeWaySymbol.md +2 -2
- package/docs/api/variables/ClientEventPrefix.md +11 -0
- package/docs/api/variables/ClientToolFuncSchema.md +4 -2
- 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 +2 -2
- package/docs/api/variables/LLM_TOKENIZER_NAMES.md +4 -4
- 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 +4 -2
- package/docs/api/variables/ResponseRStreamErrCode.md +1 -1
- package/docs/api/variables/RpcMethodsClientToolSchema.md +51 -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 +4 -2
- 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 +4 -2
- package/docs/api/variables/backendEventable.md +11 -0
- 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/docs/api/variables/makeToolFuncCancelable.md +11 -0
- package/docs/api/{functions → variables}/wait.md +16 -14
- package/docs/pubsub.md +427 -105
- package/docs/server_client_tools.md +5 -3
- package/docs/toolFunc.md +3 -1
- package/package.json +10 -9
- package/dist/chunk-LNTIQQNN.mjs +0 -1
- package/docs/api/functions/backendEventable.md +0 -29
- package/docs/api/functions/makeToolFuncCancelable.md +0 -29
- package/docs/api/interfaces/PubSubClient.md +0 -27
- package/docs/api/namespaces/uuidv5/README.md +0 -12
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: ToolFunc
|
|
8
8
|
|
|
9
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:236](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:236](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L236)
|
|
10
10
|
|
|
11
11
|
A manager for creating, registering, and executing reusable tool functions.
|
|
12
12
|
|
|
@@ -79,11 +79,11 @@ main();
|
|
|
79
79
|
|
|
80
80
|
## Constructors
|
|
81
81
|
|
|
82
|
-
###
|
|
82
|
+
### Constructor
|
|
83
83
|
|
|
84
|
-
> **new ToolFunc**(`name`, `options
|
|
84
|
+
> **new ToolFunc**(`name`, `options?`): `ToolFunc`
|
|
85
85
|
|
|
86
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:571](https://github.com/isdk/ai-tool.js/blob/
|
|
86
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:571](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L571)
|
|
87
87
|
|
|
88
88
|
Initializes a new `ToolFunc` instance.
|
|
89
89
|
|
|
@@ -103,7 +103,7 @@ Configuration options if not provided in the first argument.
|
|
|
103
103
|
|
|
104
104
|
#### Returns
|
|
105
105
|
|
|
106
|
-
|
|
106
|
+
`ToolFunc`
|
|
107
107
|
|
|
108
108
|
#### Inherited from
|
|
109
109
|
|
|
@@ -123,7 +123,7 @@ Defined in: [property-manager.js/src/advance.d.ts:5](https://github.com/snowyu/p
|
|
|
123
123
|
|
|
124
124
|
> `optional` **alias**: `string` \| `string`[]
|
|
125
125
|
|
|
126
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:130](https://github.com/isdk/ai-tool.js/blob/
|
|
126
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:130](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L130)
|
|
127
127
|
|
|
128
128
|
Optional aliases for the function name.
|
|
129
129
|
|
|
@@ -137,7 +137,7 @@ Optional aliases for the function name.
|
|
|
137
137
|
|
|
138
138
|
> `optional` **asyncFeatures**: `number`
|
|
139
139
|
|
|
140
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:144](https://github.com/isdk/ai-tool.js/blob/
|
|
140
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:144](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L144)
|
|
141
141
|
|
|
142
142
|
A bitmask representing asynchronous features supported by the function, built from `AsyncFeatureBits`.
|
|
143
143
|
This allows the system to understand if a function supports capabilities like cancellation or multi-tasking.
|
|
@@ -195,7 +195,7 @@ The default options for export and assign
|
|
|
195
195
|
|
|
196
196
|
> `optional` **depends**: `object`
|
|
197
197
|
|
|
198
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:167](https://github.com/isdk/ai-tool.js/blob/
|
|
198
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:167](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L167)
|
|
199
199
|
|
|
200
200
|
A map of dependencies this function has on other tool functions.
|
|
201
201
|
Declaring dependencies ensures that they are automatically registered when this function is registered.
|
|
@@ -203,7 +203,7 @@ This is crucial for building modular functions that rely on each other without n
|
|
|
203
203
|
|
|
204
204
|
#### Index Signature
|
|
205
205
|
|
|
206
|
-
\[`name`: `string`\]:
|
|
206
|
+
\[`name`: `string`\]: `ToolFunc`
|
|
207
207
|
|
|
208
208
|
#### Example
|
|
209
209
|
|
|
@@ -234,7 +234,7 @@ mainFunc.register();
|
|
|
234
234
|
|
|
235
235
|
> `optional` **description**: `string`
|
|
236
236
|
|
|
237
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:172](https://github.com/isdk/ai-tool.js/blob/
|
|
237
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:172](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L172)
|
|
238
238
|
|
|
239
239
|
A detailed description of what the function does.
|
|
240
240
|
|
|
@@ -248,7 +248,7 @@ A detailed description of what the function does.
|
|
|
248
248
|
|
|
249
249
|
> `optional` **isApi**: `boolean`
|
|
250
250
|
|
|
251
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:119](https://github.com/isdk/ai-tool.js/blob/
|
|
251
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:119](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L119)
|
|
252
252
|
|
|
253
253
|
If true, indicates that this function should be treated as a server-side API.
|
|
254
254
|
|
|
@@ -262,13 +262,13 @@ If true, indicates that this function should be treated as a server-side API.
|
|
|
262
262
|
|
|
263
263
|
> `optional` **name**: `string`
|
|
264
264
|
|
|
265
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:76](https://github.com/isdk/ai-tool.js/blob/
|
|
265
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:76](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L76)
|
|
266
266
|
|
|
267
267
|
The unique name of the function.
|
|
268
268
|
|
|
269
269
|
#### Inherited from
|
|
270
270
|
|
|
271
|
-
[`BaseFunc`](../interfaces/BaseFunc.md).[`name`](../interfaces/BaseFunc.md#name
|
|
271
|
+
[`BaseFunc`](../interfaces/BaseFunc.md).[`name`](../interfaces/BaseFunc.md#name)
|
|
272
272
|
|
|
273
273
|
***
|
|
274
274
|
|
|
@@ -286,7 +286,7 @@ the property with the default prefix '$' will not be exported.
|
|
|
286
286
|
|
|
287
287
|
> `optional` **params**: [`FuncParams`](../interfaces/FuncParams.md) \| [`FuncParam`](../interfaces/FuncParam.md)[]
|
|
288
288
|
|
|
289
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:81](https://github.com/isdk/ai-tool.js/blob/
|
|
289
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:81](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L81)
|
|
290
290
|
|
|
291
291
|
Parameter definitions, which can be an object mapping names to definitions or an array for positional parameters.
|
|
292
292
|
|
|
@@ -300,7 +300,7 @@ Parameter definitions, which can be an object mapping names to definitions or an
|
|
|
300
300
|
|
|
301
301
|
> `optional` **result**: `string` \| `Record`\<`string`, `any`\>
|
|
302
302
|
|
|
303
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:86](https://github.com/isdk/ai-tool.js/blob/
|
|
303
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:86](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L86)
|
|
304
304
|
|
|
305
305
|
The expected return type of the function, described as a string or a JSON schema object.
|
|
306
306
|
|
|
@@ -314,7 +314,7 @@ The expected return type of the function, described as a string or a JSON schema
|
|
|
314
314
|
|
|
315
315
|
> `optional` **scope**: `any`
|
|
316
316
|
|
|
317
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:91](https://github.com/isdk/ai-tool.js/blob/
|
|
317
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:91](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L91)
|
|
318
318
|
|
|
319
319
|
The execution scope or context (`this`) for the function.
|
|
320
320
|
|
|
@@ -326,9 +326,9 @@ The execution scope or context (`this`) for the function.
|
|
|
326
326
|
|
|
327
327
|
### setup()?
|
|
328
328
|
|
|
329
|
-
> `optional` **setup**: (`this`, `options
|
|
329
|
+
> `optional` **setup**: (`this`, `options?`) => `void`
|
|
330
330
|
|
|
331
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:114](https://github.com/isdk/ai-tool.js/blob/
|
|
331
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:114](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L114)
|
|
332
332
|
|
|
333
333
|
A lifecycle hook called once during the `ToolFunc` instance's initialization.
|
|
334
334
|
It allows for initial setup, state configuration, or property modification on the instance
|
|
@@ -338,7 +338,7 @@ before it is used or registered. The `this` context is the `ToolFunc` instance i
|
|
|
338
338
|
|
|
339
339
|
##### this
|
|
340
340
|
|
|
341
|
-
|
|
341
|
+
`ToolFunc`
|
|
342
342
|
|
|
343
343
|
##### options?
|
|
344
344
|
|
|
@@ -374,7 +374,7 @@ console.log(myFunc.customState); // Outputs: 'configured'
|
|
|
374
374
|
|
|
375
375
|
> `optional` **stream**: `boolean`
|
|
376
376
|
|
|
377
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:125](https://github.com/isdk/ai-tool.js/blob/
|
|
377
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:125](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L125)
|
|
378
378
|
|
|
379
379
|
If true, indicates that the function has the *capability* to stream its output.
|
|
380
380
|
Whether a specific call is streamed is determined by a `stream` property in the runtime parameters.
|
|
@@ -389,7 +389,7 @@ Whether a specific call is streamed is determined by a `stream` property in the
|
|
|
389
389
|
|
|
390
390
|
> `optional` **tags**: `string` \| `string`[]
|
|
391
391
|
|
|
392
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:96](https://github.com/isdk/ai-tool.js/blob/
|
|
392
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:96](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L96)
|
|
393
393
|
|
|
394
394
|
Tags for grouping or filtering functions.
|
|
395
395
|
|
|
@@ -403,7 +403,7 @@ Tags for grouping or filtering functions.
|
|
|
403
403
|
|
|
404
404
|
> `optional` **title**: `string`
|
|
405
405
|
|
|
406
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:177](https://github.com/isdk/ai-tool.js/blob/
|
|
406
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:177](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L177)
|
|
407
407
|
|
|
408
408
|
A concise, human-readable title for the function, often used in UI or by AI.
|
|
409
409
|
|
|
@@ -417,7 +417,7 @@ A concise, human-readable title for the function, often used in UI or by AI.
|
|
|
417
417
|
|
|
418
418
|
> `static` **aliases**: `object` = `{}`
|
|
419
419
|
|
|
420
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:305](https://github.com/isdk/ai-tool.js/blob/
|
|
420
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:305](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L305)
|
|
421
421
|
|
|
422
422
|
A static map of aliases to their corresponding function names.
|
|
423
423
|
|
|
@@ -431,7 +431,7 @@ A static map of aliases to their corresponding function names.
|
|
|
431
431
|
|
|
432
432
|
> `static` **dataPath**: `string`
|
|
433
433
|
|
|
434
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:312](https://github.com/isdk/ai-tool.js/blob/
|
|
434
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:312](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L312)
|
|
435
435
|
|
|
436
436
|
A conventional property to designate a file path for saving the registered `ToolFunc` data.
|
|
437
437
|
Note: The `ToolFunc` class itself does not implement persistence logic. It is up to the
|
|
@@ -443,7 +443,7 @@ developer to use this path to save and load the `ToolFunc.items` registry if nee
|
|
|
443
443
|
|
|
444
444
|
> `static` **items**: [`Funcs`](../interfaces/Funcs.md) = `{}`
|
|
445
445
|
|
|
446
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:300](https://github.com/isdk/ai-tool.js/blob/
|
|
446
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:300](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L300)
|
|
447
447
|
|
|
448
448
|
A static registry of all `ToolFunc` instances, indexed by name.
|
|
449
449
|
|
|
@@ -453,7 +453,7 @@ A static registry of all `ToolFunc` instances, indexed by name.
|
|
|
453
453
|
|
|
454
454
|
> **arr2ObjParams**(`params`): `any`[]
|
|
455
455
|
|
|
456
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:629](https://github.com/isdk/ai-tool.js/blob/
|
|
456
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:629](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L629)
|
|
457
457
|
|
|
458
458
|
Converts an array of positional arguments into a named parameters object.
|
|
459
459
|
This is used internally to support functions defined with named parameters.
|
|
@@ -476,7 +476,7 @@ An array containing a single parameters object.
|
|
|
476
476
|
|
|
477
477
|
### assign()
|
|
478
478
|
|
|
479
|
-
> **assign**(`src`, `options
|
|
479
|
+
> **assign**(`src`, `options?`): `this`
|
|
480
480
|
|
|
481
481
|
Defined in: [property-manager.js/src/abstract.d.ts:106](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L106)
|
|
482
482
|
|
|
@@ -504,7 +504,7 @@ this object
|
|
|
504
504
|
|
|
505
505
|
### assignProperty()
|
|
506
506
|
|
|
507
|
-
> **assignProperty**(`src`, `name`, `value`, `attrs
|
|
507
|
+
> **assignProperty**(`src`, `name`, `value`, `attrs?`, `options?`): `void`
|
|
508
508
|
|
|
509
509
|
Defined in: [property-manager.js/src/abstract.d.ts:117](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L117)
|
|
510
510
|
|
|
@@ -548,7 +548,7 @@ the attributes object
|
|
|
548
548
|
|
|
549
549
|
### assignPropertyTo()
|
|
550
550
|
|
|
551
|
-
> `abstract` **assignPropertyTo**(`dest`, `src`, `name`, `value`, `attrs
|
|
551
|
+
> `abstract` **assignPropertyTo**(`dest`, `src`, `name`, `value`, `attrs?`, `options?`): `void`
|
|
552
552
|
|
|
553
553
|
Defined in: [property-manager.js/src/abstract.d.ts:131](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L131)
|
|
554
554
|
|
|
@@ -598,7 +598,7 @@ The attributes object of the property
|
|
|
598
598
|
|
|
599
599
|
### assignTo()
|
|
600
600
|
|
|
601
|
-
> **assignTo**(`dest
|
|
601
|
+
> **assignTo**(`dest?`, `options?`): `any`
|
|
602
602
|
|
|
603
603
|
Defined in: [property-manager.js/src/abstract.d.ts:191](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L191)
|
|
604
604
|
|
|
@@ -626,7 +626,7 @@ the dest object
|
|
|
626
626
|
|
|
627
627
|
### clone()
|
|
628
628
|
|
|
629
|
-
> **clone**(`options
|
|
629
|
+
> **clone**(`options?`): `any`
|
|
630
630
|
|
|
631
631
|
Defined in: [property-manager.js/src/abstract.d.ts:155](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L155)
|
|
632
632
|
|
|
@@ -648,7 +648,7 @@ the new object
|
|
|
648
648
|
|
|
649
649
|
### cloneTo()
|
|
650
650
|
|
|
651
|
-
> **cloneTo**(`dest`, `options
|
|
651
|
+
> **cloneTo**(`dest`, `options?`): `any`
|
|
652
652
|
|
|
653
653
|
Defined in: [property-manager.js/src/abstract.d.ts:148](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L148)
|
|
654
654
|
|
|
@@ -698,7 +698,7 @@ the defined attributes of the object
|
|
|
698
698
|
|
|
699
699
|
### exportTo()
|
|
700
700
|
|
|
701
|
-
> **exportTo**(`dest`, `options
|
|
701
|
+
> **exportTo**(`dest`, `options?`): `any`
|
|
702
702
|
|
|
703
703
|
Defined in: [property-manager.js/src/abstract.d.ts:173](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L173)
|
|
704
704
|
|
|
@@ -728,7 +728,7 @@ the dest object.
|
|
|
728
728
|
|
|
729
729
|
> **func**(...`params`): `any`
|
|
730
730
|
|
|
731
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:202](https://github.com/isdk/ai-tool.js/blob/
|
|
731
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:202](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L202)
|
|
732
732
|
|
|
733
733
|
The actual function implementation.
|
|
734
734
|
|
|
@@ -754,9 +754,9 @@ The result of the function.
|
|
|
754
754
|
|
|
755
755
|
### getFunc()
|
|
756
756
|
|
|
757
|
-
> **getFunc**(`name
|
|
757
|
+
> **getFunc**(`name?`): `any`
|
|
758
758
|
|
|
759
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:720](https://github.com/isdk/ai-tool.js/blob/
|
|
759
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:720](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L720)
|
|
760
760
|
|
|
761
761
|
Gets a bound function reference for execution with named parameters.
|
|
762
762
|
If a name is provided, it retrieves a different function from the registry.
|
|
@@ -780,9 +780,9 @@ A function reference or `undefined` if not found.
|
|
|
780
780
|
|
|
781
781
|
### getFuncWithPos()
|
|
782
782
|
|
|
783
|
-
> **getFuncWithPos**(`name
|
|
783
|
+
> **getFuncWithPos**(`name?`): `any`
|
|
784
784
|
|
|
785
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:777](https://github.com/isdk/ai-tool.js/blob/
|
|
785
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:777](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L777)
|
|
786
786
|
|
|
787
787
|
Gets a bound function reference suitable for positional argument execution.
|
|
788
788
|
If a name is provided, it retrieves a different function from the registry.
|
|
@@ -824,7 +824,7 @@ the descriptors of properties object
|
|
|
824
824
|
|
|
825
825
|
> **hasAsyncFeature**(`feature`): `boolean`
|
|
826
826
|
|
|
827
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:787](https://github.com/isdk/ai-tool.js/blob/
|
|
827
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:787](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L787)
|
|
828
828
|
|
|
829
829
|
Checks if the current function instance supports a specific async feature.
|
|
830
830
|
|
|
@@ -868,7 +868,7 @@ A property name.
|
|
|
868
868
|
|
|
869
869
|
### initialize()
|
|
870
870
|
|
|
871
|
-
> **initialize**(`src
|
|
871
|
+
> **initialize**(`src?`): `this`
|
|
872
872
|
|
|
873
873
|
Defined in: [property-manager.js/src/abstract.d.ts:139](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L139)
|
|
874
874
|
|
|
@@ -912,7 +912,7 @@ Another object whose prototype chain is to be checked.
|
|
|
912
912
|
|
|
913
913
|
### isSame()
|
|
914
914
|
|
|
915
|
-
> **isSame**(`src`, `options
|
|
915
|
+
> **isSame**(`src`, `options?`): `boolean`
|
|
916
916
|
|
|
917
917
|
Defined in: [property-manager.js/src/abstract.d.ts:200](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L200)
|
|
918
918
|
|
|
@@ -940,7 +940,7 @@ The source object
|
|
|
940
940
|
|
|
941
941
|
> **isStream**(`params`): `undefined` \| `boolean`
|
|
942
942
|
|
|
943
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:805](https://github.com/isdk/ai-tool.js/blob/
|
|
943
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:805](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L805)
|
|
944
944
|
|
|
945
945
|
Determines if a function call should produce a stream.
|
|
946
946
|
|
|
@@ -968,7 +968,7 @@ The runtime parameters passed to the function call.
|
|
|
968
968
|
|
|
969
969
|
### mergeTo()
|
|
970
970
|
|
|
971
|
-
> **mergeTo**(`dest`, `options
|
|
971
|
+
> **mergeTo**(`dest`, `options?`): `any`
|
|
972
972
|
|
|
973
973
|
Defined in: [property-manager.js/src/abstract.d.ts:164](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L164)
|
|
974
974
|
|
|
@@ -996,9 +996,9 @@ the dest object.
|
|
|
996
996
|
|
|
997
997
|
### obj2ArrParams()
|
|
998
998
|
|
|
999
|
-
> **obj2ArrParams**(`params
|
|
999
|
+
> **obj2ArrParams**(`params?`): `any`[]
|
|
1000
1000
|
|
|
1001
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:648](https://github.com/isdk/ai-tool.js/blob/
|
|
1001
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:648](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L648)
|
|
1002
1002
|
|
|
1003
1003
|
Converts a named parameters object into an array of positional arguments.
|
|
1004
1004
|
This is used for functions defined with positional parameters.
|
|
@@ -1043,16 +1043,16 @@ A property name.
|
|
|
1043
1043
|
|
|
1044
1044
|
### register()
|
|
1045
1045
|
|
|
1046
|
-
> **register**(): `boolean` \|
|
|
1046
|
+
> **register**(): `boolean` \| `ToolFunc`
|
|
1047
1047
|
|
|
1048
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:602](https://github.com/isdk/ai-tool.js/blob/
|
|
1048
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:602](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L602)
|
|
1049
1049
|
|
|
1050
1050
|
Registers the current `ToolFunc` instance into the static registry.
|
|
1051
1051
|
Also registers any declared dependencies.
|
|
1052
1052
|
|
|
1053
1053
|
#### Returns
|
|
1054
1054
|
|
|
1055
|
-
`boolean` \|
|
|
1055
|
+
`boolean` \| `ToolFunc`
|
|
1056
1056
|
|
|
1057
1057
|
The instance itself upon successful registration, or `false` if it already exists.
|
|
1058
1058
|
|
|
@@ -1060,9 +1060,9 @@ The instance itself upon successful registration, or `false` if it already exist
|
|
|
1060
1060
|
|
|
1061
1061
|
### run()
|
|
1062
1062
|
|
|
1063
|
-
> **run**(`params
|
|
1063
|
+
> **run**(`params?`): `Promise`\<`any`\>
|
|
1064
1064
|
|
|
1065
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:686](https://github.com/isdk/ai-tool.js/blob/
|
|
1065
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:686](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L686)
|
|
1066
1066
|
|
|
1067
1067
|
Executes the function asynchronously with a named parameters object.
|
|
1068
1068
|
|
|
@@ -1084,9 +1084,9 @@ A promise that resolves with the function's result.
|
|
|
1084
1084
|
|
|
1085
1085
|
### runAs()
|
|
1086
1086
|
|
|
1087
|
-
> **runAs**(`name`, `params
|
|
1087
|
+
> **runAs**(`name`, `params?`): `Promise`\<`any`\>
|
|
1088
1088
|
|
|
1089
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:697](https://github.com/isdk/ai-tool.js/blob/
|
|
1089
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:697](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L697)
|
|
1090
1090
|
|
|
1091
1091
|
Asynchronously executes another registered function by name.
|
|
1092
1092
|
This method delegates to `runAsSync()` internally.
|
|
@@ -1115,9 +1115,9 @@ A promise that resolves with the result of the function execution.
|
|
|
1115
1115
|
|
|
1116
1116
|
### runAsSync()
|
|
1117
1117
|
|
|
1118
|
-
> **runAsSync**(`name`, `params
|
|
1118
|
+
> **runAsSync**(`name`, `params?`): `any`
|
|
1119
1119
|
|
|
1120
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:708](https://github.com/isdk/ai-tool.js/blob/
|
|
1120
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:708](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L708)
|
|
1121
1121
|
|
|
1122
1122
|
Synchronously executes another registered function by name.
|
|
1123
1123
|
This is a convenience method that forwards the call to the static `runSync()` method.
|
|
@@ -1146,9 +1146,9 @@ The result of the function execution.
|
|
|
1146
1146
|
|
|
1147
1147
|
### runSync()
|
|
1148
1148
|
|
|
1149
|
-
> **runSync**(`params
|
|
1149
|
+
> **runSync**(`params?`): `any`
|
|
1150
1150
|
|
|
1151
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:667](https://github.com/isdk/ai-tool.js/blob/
|
|
1151
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:667](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L667)
|
|
1152
1152
|
|
|
1153
1153
|
Executes the function synchronously with a named parameters object.
|
|
1154
1154
|
|
|
@@ -1176,7 +1176,7 @@ Will throw an error if an array of parameters is passed to a function that expec
|
|
|
1176
1176
|
|
|
1177
1177
|
> **runWithPos**(...`params`): `Promise`\<`any`\>
|
|
1178
1178
|
|
|
1179
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:755](https://github.com/isdk/ai-tool.js/blob/
|
|
1179
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:755](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L755)
|
|
1180
1180
|
|
|
1181
1181
|
Executes the function asynchronously using positional arguments.
|
|
1182
1182
|
Delegates to `runWithPosSync()` internally.
|
|
@@ -1201,7 +1201,7 @@ A promise that resolves with the result of the function execution.
|
|
|
1201
1201
|
|
|
1202
1202
|
> **runWithPosAs**(`name`, ...`params`): `Promise`\<`any`\>
|
|
1203
1203
|
|
|
1204
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:766](https://github.com/isdk/ai-tool.js/blob/
|
|
1204
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:766](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L766)
|
|
1205
1205
|
|
|
1206
1206
|
Asynchronously executes another function by name using positional arguments.
|
|
1207
1207
|
Delegates to `runWithPosAsSync()` internally.
|
|
@@ -1232,7 +1232,7 @@ A promise that resolves with the result of the function execution.
|
|
|
1232
1232
|
|
|
1233
1233
|
> **runWithPosAsSync**(`name`, ...`params`): `any`
|
|
1234
1234
|
|
|
1235
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:745](https://github.com/isdk/ai-tool.js/blob/
|
|
1235
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:745](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L745)
|
|
1236
1236
|
|
|
1237
1237
|
Synchronously executes another function by name using positional arguments.
|
|
1238
1238
|
This is a convenience wrapper around the static `runWithPosSync()` method.
|
|
@@ -1263,7 +1263,7 @@ The result of the function execution.
|
|
|
1263
1263
|
|
|
1264
1264
|
> **runWithPosSync**(...`params`): `any`
|
|
1265
1265
|
|
|
1266
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:731](https://github.com/isdk/ai-tool.js/blob/
|
|
1266
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:731](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L731)
|
|
1267
1267
|
|
|
1268
1268
|
Executes the function synchronously using positional arguments.
|
|
1269
1269
|
If the function expects named parameters, it converts the arguments automatically.
|
|
@@ -1312,7 +1312,7 @@ Returns a date converted to a string using the current locale.
|
|
|
1312
1312
|
|
|
1313
1313
|
### toObject()
|
|
1314
1314
|
|
|
1315
|
-
> **toObject**(`options
|
|
1315
|
+
> **toObject**(`options?`): `any`
|
|
1316
1316
|
|
|
1317
1317
|
Defined in: [property-manager.js/src/abstract.d.ts:181](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L181)
|
|
1318
1318
|
|
|
@@ -1350,7 +1350,7 @@ Returns a string representation of an object.
|
|
|
1350
1350
|
|
|
1351
1351
|
> **unregister**(): `any`
|
|
1352
1352
|
|
|
1353
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:619](https://github.com/isdk/ai-tool.js/blob/
|
|
1353
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:619](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L619)
|
|
1354
1354
|
|
|
1355
1355
|
Removes the current `ToolFunc` instance from the static registry.
|
|
1356
1356
|
|
|
@@ -1389,9 +1389,13 @@ target object. Returns the target object.
|
|
|
1389
1389
|
|
|
1390
1390
|
##### Type Parameters
|
|
1391
1391
|
|
|
1392
|
-
|
|
1392
|
+
###### T
|
|
1393
1393
|
|
|
1394
|
-
|
|
1394
|
+
`T` *extends* `object`
|
|
1395
|
+
|
|
1396
|
+
###### U
|
|
1397
|
+
|
|
1398
|
+
`U`
|
|
1395
1399
|
|
|
1396
1400
|
##### Parameters
|
|
1397
1401
|
|
|
@@ -1422,11 +1426,17 @@ target object. Returns the target object.
|
|
|
1422
1426
|
|
|
1423
1427
|
##### Type Parameters
|
|
1424
1428
|
|
|
1425
|
-
|
|
1429
|
+
###### T
|
|
1430
|
+
|
|
1431
|
+
`T` *extends* `object`
|
|
1432
|
+
|
|
1433
|
+
###### U
|
|
1434
|
+
|
|
1435
|
+
`U`
|
|
1426
1436
|
|
|
1427
|
-
|
|
1437
|
+
###### V
|
|
1428
1438
|
|
|
1429
|
-
|
|
1439
|
+
`V`
|
|
1430
1440
|
|
|
1431
1441
|
##### Parameters
|
|
1432
1442
|
|
|
@@ -1463,13 +1473,21 @@ target object. Returns the target object.
|
|
|
1463
1473
|
|
|
1464
1474
|
##### Type Parameters
|
|
1465
1475
|
|
|
1466
|
-
|
|
1476
|
+
###### T
|
|
1477
|
+
|
|
1478
|
+
`T` *extends* `object`
|
|
1467
1479
|
|
|
1468
|
-
|
|
1480
|
+
###### U
|
|
1469
1481
|
|
|
1470
|
-
|
|
1482
|
+
`U`
|
|
1483
|
+
|
|
1484
|
+
###### V
|
|
1471
1485
|
|
|
1472
|
-
|
|
1486
|
+
`V`
|
|
1487
|
+
|
|
1488
|
+
###### W
|
|
1489
|
+
|
|
1490
|
+
`W`
|
|
1473
1491
|
|
|
1474
1492
|
##### Parameters
|
|
1475
1493
|
|
|
@@ -1582,7 +1600,7 @@ JavaScript object that contains one or more property descriptors.
|
|
|
1582
1600
|
|
|
1583
1601
|
### defineProperties()
|
|
1584
1602
|
|
|
1585
|
-
> `static` **defineProperties**(`aTarget`, `aProperties`, `recreate
|
|
1603
|
+
> `static` **defineProperties**(`aTarget`, `aProperties`, `recreate?`): `any`
|
|
1586
1604
|
|
|
1587
1605
|
Defined in: [property-manager.js/src/advance.d.ts:11](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/advance.d.ts#L11)
|
|
1588
1606
|
|
|
@@ -1618,7 +1636,9 @@ Adds a property to an object, or modifies attributes of an existing property.
|
|
|
1618
1636
|
|
|
1619
1637
|
#### Type Parameters
|
|
1620
1638
|
|
|
1621
|
-
|
|
1639
|
+
##### T
|
|
1640
|
+
|
|
1641
|
+
`T`
|
|
1622
1642
|
|
|
1623
1643
|
#### Parameters
|
|
1624
1644
|
|
|
@@ -1658,7 +1678,9 @@ Returns an array of key/values of the enumerable own properties of an object
|
|
|
1658
1678
|
|
|
1659
1679
|
##### Type Parameters
|
|
1660
1680
|
|
|
1661
|
-
|
|
1681
|
+
###### T
|
|
1682
|
+
|
|
1683
|
+
`T`
|
|
1662
1684
|
|
|
1663
1685
|
##### Parameters
|
|
1664
1686
|
|
|
@@ -1666,7 +1688,7 @@ Returns an array of key/values of the enumerable own properties of an object
|
|
|
1666
1688
|
|
|
1667
1689
|
Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.
|
|
1668
1690
|
|
|
1669
|
-
\{\} | `ArrayLike`\<`T`\>
|
|
1691
|
+
\{\[`s`: `string`\]: `T`; \} | `ArrayLike`\<`T`\>
|
|
1670
1692
|
|
|
1671
1693
|
##### Returns
|
|
1672
1694
|
|
|
@@ -1704,7 +1726,9 @@ Prevents the modification of existing property attributes and values, and preven
|
|
|
1704
1726
|
|
|
1705
1727
|
##### Type Parameters
|
|
1706
1728
|
|
|
1707
|
-
|
|
1729
|
+
###### T
|
|
1730
|
+
|
|
1731
|
+
`T` *extends* `Function`
|
|
1708
1732
|
|
|
1709
1733
|
##### Parameters
|
|
1710
1734
|
|
|
@@ -1728,9 +1752,13 @@ Prevents the modification of existing property attributes and values, and preven
|
|
|
1728
1752
|
|
|
1729
1753
|
##### Type Parameters
|
|
1730
1754
|
|
|
1731
|
-
|
|
1755
|
+
###### T
|
|
1756
|
+
|
|
1757
|
+
`T` *extends* `object`
|
|
1732
1758
|
|
|
1733
|
-
|
|
1759
|
+
###### U
|
|
1760
|
+
|
|
1761
|
+
`U` *extends* `string` \| `number` \| `bigint` \| `boolean` \| `symbol`
|
|
1734
1762
|
|
|
1735
1763
|
##### Parameters
|
|
1736
1764
|
|
|
@@ -1754,7 +1782,9 @@ Prevents the modification of existing property attributes and values, and preven
|
|
|
1754
1782
|
|
|
1755
1783
|
##### Type Parameters
|
|
1756
1784
|
|
|
1757
|
-
|
|
1785
|
+
###### T
|
|
1786
|
+
|
|
1787
|
+
`T`
|
|
1758
1788
|
|
|
1759
1789
|
##### Parameters
|
|
1760
1790
|
|
|
@@ -1782,7 +1812,9 @@ Returns an object created by key-value entries for properties and methods
|
|
|
1782
1812
|
|
|
1783
1813
|
##### Type Parameters
|
|
1784
1814
|
|
|
1785
|
-
|
|
1815
|
+
###### T
|
|
1816
|
+
|
|
1817
|
+
`T` = `any`
|
|
1786
1818
|
|
|
1787
1819
|
##### Parameters
|
|
1788
1820
|
|
|
@@ -1820,9 +1852,9 @@ An iterable object that contains key-value entries for properties and methods.
|
|
|
1820
1852
|
|
|
1821
1853
|
### get()
|
|
1822
1854
|
|
|
1823
|
-
> `static` **get**(`name`):
|
|
1855
|
+
> `static` **get**(`name`): `ToolFunc`
|
|
1824
1856
|
|
|
1825
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:319](https://github.com/isdk/ai-tool.js/blob/
|
|
1857
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:319](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L319)
|
|
1826
1858
|
|
|
1827
1859
|
Retrieves a registered function by its name or alias.
|
|
1828
1860
|
|
|
@@ -1836,7 +1868,7 @@ The name or alias of the function to retrieve.
|
|
|
1836
1868
|
|
|
1837
1869
|
#### Returns
|
|
1838
1870
|
|
|
1839
|
-
|
|
1871
|
+
`ToolFunc`
|
|
1840
1872
|
|
|
1841
1873
|
The `ToolFunc` instance if found, otherwise `undefined`.
|
|
1842
1874
|
|
|
@@ -1844,9 +1876,9 @@ The `ToolFunc` instance if found, otherwise `undefined`.
|
|
|
1844
1876
|
|
|
1845
1877
|
### getAllByTag()
|
|
1846
1878
|
|
|
1847
|
-
> `static` **getAllByTag**(`tagName`):
|
|
1879
|
+
> `static` **getAllByTag**(`tagName`): `ToolFunc`[]
|
|
1848
1880
|
|
|
1849
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:365](https://github.com/isdk/ai-tool.js/blob/
|
|
1881
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:365](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L365)
|
|
1850
1882
|
|
|
1851
1883
|
Retrieves all registered functions that have a specific tag.
|
|
1852
1884
|
|
|
@@ -1860,7 +1892,7 @@ The tag to search for.
|
|
|
1860
1892
|
|
|
1861
1893
|
#### Returns
|
|
1862
1894
|
|
|
1863
|
-
|
|
1895
|
+
`ToolFunc`[]
|
|
1864
1896
|
|
|
1865
1897
|
An array of matching `ToolFunc` instances.
|
|
1866
1898
|
|
|
@@ -1868,9 +1900,9 @@ An array of matching `ToolFunc` instances.
|
|
|
1868
1900
|
|
|
1869
1901
|
### getByTag()
|
|
1870
1902
|
|
|
1871
|
-
> `static` **getByTag**(`tagName`): `undefined` \|
|
|
1903
|
+
> `static` **getByTag**(`tagName`): `undefined` \| `ToolFunc`
|
|
1872
1904
|
|
|
1873
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:340](https://github.com/isdk/ai-tool.js/blob/
|
|
1905
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:340](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L340)
|
|
1874
1906
|
|
|
1875
1907
|
Finds the first registered function that has a specific tag.
|
|
1876
1908
|
|
|
@@ -1884,7 +1916,7 @@ The tag to search for.
|
|
|
1884
1916
|
|
|
1885
1917
|
#### Returns
|
|
1886
1918
|
|
|
1887
|
-
`undefined` \|
|
|
1919
|
+
`undefined` \| `ToolFunc`
|
|
1888
1920
|
|
|
1889
1921
|
The first matching `ToolFunc` instance, or `undefined` if none is found.
|
|
1890
1922
|
|
|
@@ -1894,7 +1926,7 @@ The first matching `ToolFunc` instance, or `undefined` if none is found.
|
|
|
1894
1926
|
|
|
1895
1927
|
> `static` **getFunc**(`name`): `any`
|
|
1896
1928
|
|
|
1897
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:431](https://github.com/isdk/ai-tool.js/blob/
|
|
1929
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:431](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L431)
|
|
1898
1930
|
|
|
1899
1931
|
Retrieves a bound, runnable function reference for a registered function.
|
|
1900
1932
|
This reference is suitable for execution with an object of named parameters.
|
|
@@ -1919,7 +1951,7 @@ A bound function reference, or `undefined` if not found.
|
|
|
1919
1951
|
|
|
1920
1952
|
> `static` **getFuncWithPos**(`name`): `any`
|
|
1921
1953
|
|
|
1922
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:472](https://github.com/isdk/ai-tool.js/blob/
|
|
1954
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:472](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L472)
|
|
1923
1955
|
|
|
1924
1956
|
Retrieves a bound, runnable function reference for a registered function.
|
|
1925
1957
|
This reference is suitable for execution with positional arguments.
|
|
@@ -1979,7 +2011,9 @@ Returns an object containing all own property descriptors of an object
|
|
|
1979
2011
|
|
|
1980
2012
|
#### Type Parameters
|
|
1981
2013
|
|
|
1982
|
-
|
|
2014
|
+
##### T
|
|
2015
|
+
|
|
2016
|
+
`T`
|
|
1983
2017
|
|
|
1984
2018
|
#### Parameters
|
|
1985
2019
|
|
|
@@ -2080,7 +2114,7 @@ The object that references the prototype.
|
|
|
2080
2114
|
|
|
2081
2115
|
> `static` **hasAsyncFeature**(`feature`): `boolean`
|
|
2082
2116
|
|
|
2083
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:388](https://github.com/isdk/ai-tool.js/blob/
|
|
2117
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:388](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L388)
|
|
2084
2118
|
|
|
2085
2119
|
Checks if any registered function has a specific asynchronous feature.
|
|
2086
2120
|
|
|
@@ -2268,7 +2302,7 @@ Object that contains the properties and methods. This can be an object that you
|
|
|
2268
2302
|
|
|
2269
2303
|
> `static` **list**(): [`Funcs`](../interfaces/Funcs.md)
|
|
2270
2304
|
|
|
2271
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:331](https://github.com/isdk/ai-tool.js/blob/
|
|
2305
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:331](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L331)
|
|
2272
2306
|
|
|
2273
2307
|
Returns the complete map of all registered functions.
|
|
2274
2308
|
|
|
@@ -2290,7 +2324,9 @@ Prevents the addition of new properties to an object.
|
|
|
2290
2324
|
|
|
2291
2325
|
#### Type Parameters
|
|
2292
2326
|
|
|
2293
|
-
|
|
2327
|
+
##### T
|
|
2328
|
+
|
|
2329
|
+
`T`
|
|
2294
2330
|
|
|
2295
2331
|
#### Parameters
|
|
2296
2332
|
|
|
@@ -2310,9 +2346,9 @@ Object to make non-extensible.
|
|
|
2310
2346
|
|
|
2311
2347
|
#### Call Signature
|
|
2312
2348
|
|
|
2313
|
-
> `static` **register**(`name`, `options`): `boolean` \|
|
|
2349
|
+
> `static` **register**(`name`, `options`): `boolean` \| `ToolFunc`
|
|
2314
2350
|
|
|
2315
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:495](https://github.com/isdk/ai-tool.js/blob/
|
|
2351
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:495](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L495)
|
|
2316
2352
|
|
|
2317
2353
|
Registers a new tool function.
|
|
2318
2354
|
|
|
@@ -2332,19 +2368,15 @@ The function's configuration.
|
|
|
2332
2368
|
|
|
2333
2369
|
##### Returns
|
|
2334
2370
|
|
|
2335
|
-
`boolean` \|
|
|
2336
|
-
|
|
2337
|
-
The new `ToolFunc` instance, or `false` if a function with that name already exists.
|
|
2338
|
-
|
|
2339
|
-
The new `ToolFunc` instance, or `false` if a function with that name already exists.
|
|
2371
|
+
`boolean` \| `ToolFunc`
|
|
2340
2372
|
|
|
2341
2373
|
The new `ToolFunc` instance, or `false` if a function with that name already exists.
|
|
2342
2374
|
|
|
2343
2375
|
#### Call Signature
|
|
2344
2376
|
|
|
2345
|
-
> `static` **register**(`func`, `options`): `boolean` \|
|
|
2377
|
+
> `static` **register**(`func`, `options`): `boolean` \| `ToolFunc`
|
|
2346
2378
|
|
|
2347
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:496](https://github.com/isdk/ai-tool.js/blob/
|
|
2379
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:496](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L496)
|
|
2348
2380
|
|
|
2349
2381
|
Registers a new tool function.
|
|
2350
2382
|
|
|
@@ -2364,19 +2396,15 @@ The function's configuration.
|
|
|
2364
2396
|
|
|
2365
2397
|
##### Returns
|
|
2366
2398
|
|
|
2367
|
-
`boolean` \|
|
|
2368
|
-
|
|
2369
|
-
The new `ToolFunc` instance, or `false` if a function with that name already exists.
|
|
2370
|
-
|
|
2371
|
-
The new `ToolFunc` instance, or `false` if a function with that name already exists.
|
|
2399
|
+
`boolean` \| `ToolFunc`
|
|
2372
2400
|
|
|
2373
2401
|
The new `ToolFunc` instance, or `false` if a function with that name already exists.
|
|
2374
2402
|
|
|
2375
2403
|
#### Call Signature
|
|
2376
2404
|
|
|
2377
|
-
> `static` **register**(`name`, `options
|
|
2405
|
+
> `static` **register**(`name`, `options?`): `boolean` \| `ToolFunc`
|
|
2378
2406
|
|
|
2379
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:497](https://github.com/isdk/ai-tool.js/blob/
|
|
2407
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:497](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L497)
|
|
2380
2408
|
|
|
2381
2409
|
Registers a new tool function.
|
|
2382
2410
|
|
|
@@ -2386,7 +2414,7 @@ Registers a new tool function.
|
|
|
2386
2414
|
|
|
2387
2415
|
The name of the function.
|
|
2388
2416
|
|
|
2389
|
-
`string` | `Function` |
|
|
2417
|
+
`string` | `Function` | `ToolFunc` | [`FuncItem`](../interfaces/FuncItem.md)
|
|
2390
2418
|
|
|
2391
2419
|
###### options?
|
|
2392
2420
|
|
|
@@ -2396,11 +2424,7 @@ The function's configuration.
|
|
|
2396
2424
|
|
|
2397
2425
|
##### Returns
|
|
2398
2426
|
|
|
2399
|
-
`boolean` \|
|
|
2400
|
-
|
|
2401
|
-
The new `ToolFunc` instance, or `false` if a function with that name already exists.
|
|
2402
|
-
|
|
2403
|
-
The new `ToolFunc` instance, or `false` if a function with that name already exists.
|
|
2427
|
+
`boolean` \| `ToolFunc`
|
|
2404
2428
|
|
|
2405
2429
|
The new `ToolFunc` instance, or `false` if a function with that name already exists.
|
|
2406
2430
|
|
|
@@ -2408,9 +2432,9 @@ The new `ToolFunc` instance, or `false` if a function with that name already exi
|
|
|
2408
2432
|
|
|
2409
2433
|
### run()
|
|
2410
2434
|
|
|
2411
|
-
> `static` **run**(`name`, `params
|
|
2435
|
+
> `static` **run**(`name`, `params?`): `Promise`\<`any`\>
|
|
2412
2436
|
|
|
2413
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:402](https://github.com/isdk/ai-tool.js/blob/
|
|
2437
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:402](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L402)
|
|
2414
2438
|
|
|
2415
2439
|
Asynchronously executes a registered function by name with named parameters.
|
|
2416
2440
|
|
|
@@ -2442,9 +2466,9 @@ If the function with the given name is not found.
|
|
|
2442
2466
|
|
|
2443
2467
|
### runSync()
|
|
2444
2468
|
|
|
2445
|
-
> `static` **runSync**(`name`, `params
|
|
2469
|
+
> `static` **runSync**(`name`, `params?`): `any`
|
|
2446
2470
|
|
|
2447
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:417](https://github.com/isdk/ai-tool.js/blob/
|
|
2471
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:417](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L417)
|
|
2448
2472
|
|
|
2449
2473
|
Synchronously executes a registered function by name with named parameters.
|
|
2450
2474
|
|
|
@@ -2478,7 +2502,7 @@ If the function with the given name is not found.
|
|
|
2478
2502
|
|
|
2479
2503
|
> `static` **runWithPos**(`name`, ...`params`): `Promise`\<`any`\>
|
|
2480
2504
|
|
|
2481
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:443](https://github.com/isdk/ai-tool.js/blob/
|
|
2505
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:443](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L443)
|
|
2482
2506
|
|
|
2483
2507
|
Asynchronously executes a function using positional arguments.
|
|
2484
2508
|
|
|
@@ -2512,7 +2536,7 @@ If the function with the given name is not found.
|
|
|
2512
2536
|
|
|
2513
2537
|
> `static` **runWithPosSync**(`name`, ...`params`): `any`
|
|
2514
2538
|
|
|
2515
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:458](https://github.com/isdk/ai-tool.js/blob/
|
|
2539
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:458](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L458)
|
|
2516
2540
|
|
|
2517
2541
|
Synchronously executes a function using positional arguments.
|
|
2518
2542
|
|
|
@@ -2552,7 +2576,9 @@ Prevents the modification of attributes of existing properties, and prevents the
|
|
|
2552
2576
|
|
|
2553
2577
|
#### Type Parameters
|
|
2554
2578
|
|
|
2555
|
-
|
|
2579
|
+
##### T
|
|
2580
|
+
|
|
2581
|
+
`T`
|
|
2556
2582
|
|
|
2557
2583
|
#### Parameters
|
|
2558
2584
|
|
|
@@ -2598,9 +2624,9 @@ The value of the new prototype or null.
|
|
|
2598
2624
|
|
|
2599
2625
|
### unregister()
|
|
2600
2626
|
|
|
2601
|
-
> `static` **unregister**(`name`): `undefined` \|
|
|
2627
|
+
> `static` **unregister**(`name`): `undefined` \| `ToolFunc`
|
|
2602
2628
|
|
|
2603
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:547](https://github.com/isdk/ai-tool.js/blob/
|
|
2629
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:547](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L547)
|
|
2604
2630
|
|
|
2605
2631
|
Unregisters a function by its name, also removing any associated aliases.
|
|
2606
2632
|
|
|
@@ -2614,7 +2640,7 @@ The name of the function to unregister.
|
|
|
2614
2640
|
|
|
2615
2641
|
#### Returns
|
|
2616
2642
|
|
|
2617
|
-
`undefined` \|
|
|
2643
|
+
`undefined` \| `ToolFunc`
|
|
2618
2644
|
|
|
2619
2645
|
The unregistered `ToolFunc` instance, or `undefined` if it was not found.
|
|
2620
2646
|
|
|
@@ -2632,7 +2658,9 @@ Returns an array of values of the enumerable own properties of an object
|
|
|
2632
2658
|
|
|
2633
2659
|
##### Type Parameters
|
|
2634
2660
|
|
|
2635
|
-
|
|
2661
|
+
###### T
|
|
2662
|
+
|
|
2663
|
+
`T`
|
|
2636
2664
|
|
|
2637
2665
|
##### Parameters
|
|
2638
2666
|
|
|
@@ -2640,7 +2668,7 @@ Returns an array of values of the enumerable own properties of an object
|
|
|
2640
2668
|
|
|
2641
2669
|
Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.
|
|
2642
2670
|
|
|
2643
|
-
\{\} | `ArrayLike`\<`T`\>
|
|
2671
|
+
\{\[`s`: `string`\]: `T`; \} | `ArrayLike`\<`T`\>
|
|
2644
2672
|
|
|
2645
2673
|
##### Returns
|
|
2646
2674
|
|