@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: ServerTools
|
|
8
8
|
|
|
9
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:41](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:41](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/server-tools.ts#L41)
|
|
10
10
|
|
|
11
11
|
Represents a function that runs on a server and can be exposed to clients.
|
|
12
12
|
|
|
@@ -18,19 +18,23 @@ server-side execution contexts. It is designed to work with a transport layer
|
|
|
18
18
|
|
|
19
19
|
- [`ServerFuncItem`](../interfaces/ServerFuncItem.md).[`ToolFunc`](ToolFunc.md)
|
|
20
20
|
|
|
21
|
+
## Extended by
|
|
22
|
+
|
|
23
|
+
- [`RpcMethodsServerTool`](RpcMethodsServerTool.md)
|
|
24
|
+
|
|
21
25
|
## Indexable
|
|
22
26
|
|
|
23
27
|
\[`name`: `string`\]: `any`
|
|
24
28
|
|
|
25
29
|
## Constructors
|
|
26
30
|
|
|
27
|
-
###
|
|
31
|
+
### Constructor
|
|
28
32
|
|
|
29
|
-
> **new ServerTools**(`name`, `options
|
|
33
|
+
> **new ServerTools**(`name`, `options?`): `ServerTools`
|
|
30
34
|
|
|
31
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:571](https://github.com/isdk/ai-tool.js/blob/
|
|
35
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:571](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L571)
|
|
32
36
|
|
|
33
|
-
|
|
37
|
+
Initializes a new `ToolFunc` instance.
|
|
34
38
|
|
|
35
39
|
#### Parameters
|
|
36
40
|
|
|
@@ -48,11 +52,11 @@ Configuration options if not provided in the first argument.
|
|
|
48
52
|
|
|
49
53
|
#### Returns
|
|
50
54
|
|
|
51
|
-
|
|
55
|
+
`ServerTools`
|
|
52
56
|
|
|
53
57
|
#### Inherited from
|
|
54
58
|
|
|
55
|
-
[`ToolFunc`](ToolFunc.md).[`constructor`](ToolFunc.md#
|
|
59
|
+
[`ToolFunc`](ToolFunc.md).[`constructor`](ToolFunc.md#constructor)
|
|
56
60
|
|
|
57
61
|
## Properties
|
|
58
62
|
|
|
@@ -64,7 +68,7 @@ Defined in: [property-manager.js/src/advance.d.ts:5](https://github.com/snowyu/p
|
|
|
64
68
|
|
|
65
69
|
#### Inherited from
|
|
66
70
|
|
|
67
|
-
[`ToolFunc`](ToolFunc.md).[`$attributes`](ToolFunc.md
|
|
71
|
+
[`ToolFunc`](ToolFunc.md).[`$attributes`](ToolFunc.md#attributes)
|
|
68
72
|
|
|
69
73
|
***
|
|
70
74
|
|
|
@@ -72,7 +76,7 @@ Defined in: [property-manager.js/src/advance.d.ts:5](https://github.com/snowyu/p
|
|
|
72
76
|
|
|
73
77
|
> `optional` **action**: `"get"` \| `"post"` \| `"put"` \| `"delete"` \| `"patch"` \| `"list"` \| `"res"`
|
|
74
78
|
|
|
75
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:95](https://github.com/isdk/ai-tool.js/blob/
|
|
79
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:95](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/consts.ts#L95)
|
|
76
80
|
|
|
77
81
|
The action to be used for the remote call. This typically represents an RPC method name.
|
|
78
82
|
Only for RESTful HTTP transports, it might be mapped to a standard HTTP method (e.g., GET, POST)
|
|
@@ -87,13 +91,13 @@ Only for RESTful HTTP transports, it might be mapped to a standard HTTP method (
|
|
|
87
91
|
|
|
88
92
|
> `optional` **alias**: `string` \| `string`[]
|
|
89
93
|
|
|
90
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:130](https://github.com/isdk/ai-tool.js/blob/
|
|
94
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:130](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L130)
|
|
91
95
|
|
|
92
96
|
Optional aliases for the function name.
|
|
93
97
|
|
|
94
98
|
#### Inherited from
|
|
95
99
|
|
|
96
|
-
[`
|
|
100
|
+
[`ServerFuncItem`](../interfaces/ServerFuncItem.md).[`alias`](../interfaces/ServerFuncItem.md#alias)
|
|
97
101
|
|
|
98
102
|
***
|
|
99
103
|
|
|
@@ -101,7 +105,7 @@ Optional aliases for the function name.
|
|
|
101
105
|
|
|
102
106
|
> `optional` **allowExportFunc**: `boolean`
|
|
103
107
|
|
|
104
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:35](https://github.com/isdk/ai-tool.js/blob/
|
|
108
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:35](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/server-tools.ts#L35)
|
|
105
109
|
|
|
106
110
|
If set to true, the body of the function (`func`) will be serialized and sent
|
|
107
111
|
to the client when tools are loaded. This allows the client to execute the
|
|
@@ -117,7 +121,7 @@ function locally instead of making a remote call. Defaults to false.
|
|
|
117
121
|
|
|
118
122
|
> `optional` **apiRoot**: `string`
|
|
119
123
|
|
|
120
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:89](https://github.com/isdk/ai-tool.js/blob/
|
|
124
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:89](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/consts.ts#L89)
|
|
121
125
|
|
|
122
126
|
The root endpoint for the remote service.
|
|
123
127
|
|
|
@@ -135,7 +139,7 @@ Use `transport` instead.
|
|
|
135
139
|
|
|
136
140
|
> `optional` **asyncFeatures**: `number`
|
|
137
141
|
|
|
138
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:144](https://github.com/isdk/ai-tool.js/blob/
|
|
142
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:144](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L144)
|
|
139
143
|
|
|
140
144
|
A bitmask representing asynchronous features supported by the function, built from `AsyncFeatureBits`.
|
|
141
145
|
This allows the system to understand if a function supports capabilities like cancellation or multi-tasking.
|
|
@@ -157,7 +161,7 @@ const func = new ToolFunc({
|
|
|
157
161
|
|
|
158
162
|
#### Inherited from
|
|
159
163
|
|
|
160
|
-
[`
|
|
164
|
+
[`ServerFuncItem`](../interfaces/ServerFuncItem.md).[`asyncFeatures`](../interfaces/ServerFuncItem.md#asyncfeatures)
|
|
161
165
|
|
|
162
166
|
***
|
|
163
167
|
|
|
@@ -197,7 +201,7 @@ The default options for export and assign
|
|
|
197
201
|
|
|
198
202
|
> `optional` **depends**: `object`
|
|
199
203
|
|
|
200
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:167](https://github.com/isdk/ai-tool.js/blob/
|
|
204
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:167](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L167)
|
|
201
205
|
|
|
202
206
|
A map of dependencies this function has on other tool functions.
|
|
203
207
|
Declaring dependencies ensures that they are automatically registered when this function is registered.
|
|
@@ -228,7 +232,7 @@ mainFunc.register();
|
|
|
228
232
|
|
|
229
233
|
#### Inherited from
|
|
230
234
|
|
|
231
|
-
[`
|
|
235
|
+
[`ServerFuncItem`](../interfaces/ServerFuncItem.md).[`depends`](../interfaces/ServerFuncItem.md#depends)
|
|
232
236
|
|
|
233
237
|
***
|
|
234
238
|
|
|
@@ -236,27 +240,23 @@ mainFunc.register();
|
|
|
236
240
|
|
|
237
241
|
> `optional` **description**: `string`
|
|
238
242
|
|
|
239
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:172](https://github.com/isdk/ai-tool.js/blob/
|
|
243
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:172](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L172)
|
|
240
244
|
|
|
241
245
|
A detailed description of what the function does.
|
|
242
246
|
|
|
243
247
|
#### Inherited from
|
|
244
248
|
|
|
245
|
-
[`
|
|
249
|
+
[`ServerFuncItem`](../interfaces/ServerFuncItem.md).[`description`](../interfaces/ServerFuncItem.md#description)
|
|
246
250
|
|
|
247
251
|
***
|
|
248
252
|
|
|
249
|
-
###
|
|
253
|
+
### fetchOptions?
|
|
250
254
|
|
|
251
255
|
> `optional` **fetchOptions**: `any`
|
|
252
256
|
|
|
253
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:
|
|
254
|
-
|
|
255
|
-
Options to be passed to the underlying `fetch` call in an HTTP transport.
|
|
257
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:100](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/consts.ts#L100)
|
|
256
258
|
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
Use `transport` instead.
|
|
259
|
+
Addtional options to be passed to the underlying `fetch` call in a transport.
|
|
260
260
|
|
|
261
261
|
#### Inherited from
|
|
262
262
|
|
|
@@ -268,13 +268,13 @@ Use `transport` instead.
|
|
|
268
268
|
|
|
269
269
|
> `optional` **isApi**: `boolean`
|
|
270
270
|
|
|
271
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:119](https://github.com/isdk/ai-tool.js/blob/
|
|
271
|
+
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)
|
|
272
272
|
|
|
273
273
|
If true, indicates that this function should be treated as a server-side API.
|
|
274
274
|
|
|
275
275
|
#### Inherited from
|
|
276
276
|
|
|
277
|
-
[`
|
|
277
|
+
[`ServerFuncItem`](../interfaces/ServerFuncItem.md).[`isApi`](../interfaces/ServerFuncItem.md#isapi)
|
|
278
278
|
|
|
279
279
|
***
|
|
280
280
|
|
|
@@ -282,13 +282,13 @@ If true, indicates that this function should be treated as a server-side API.
|
|
|
282
282
|
|
|
283
283
|
> `optional` **name**: `string`
|
|
284
284
|
|
|
285
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:76](https://github.com/isdk/ai-tool.js/blob/
|
|
285
|
+
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)
|
|
286
286
|
|
|
287
287
|
The unique name of the function.
|
|
288
288
|
|
|
289
289
|
#### Inherited from
|
|
290
290
|
|
|
291
|
-
[`
|
|
291
|
+
[`ServerFuncItem`](../interfaces/ServerFuncItem.md).[`name`](../interfaces/ServerFuncItem.md#name)
|
|
292
292
|
|
|
293
293
|
***
|
|
294
294
|
|
|
@@ -310,13 +310,13 @@ the property with the default prefix '$' will not be exported.
|
|
|
310
310
|
|
|
311
311
|
> `optional` **params**: [`FuncParams`](../interfaces/FuncParams.md) \| [`FuncParam`](../interfaces/FuncParam.md)[]
|
|
312
312
|
|
|
313
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:81](https://github.com/isdk/ai-tool.js/blob/
|
|
313
|
+
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)
|
|
314
314
|
|
|
315
315
|
Parameter definitions, which can be an object mapping names to definitions or an array for positional parameters.
|
|
316
316
|
|
|
317
317
|
#### Inherited from
|
|
318
318
|
|
|
319
|
-
[`
|
|
319
|
+
[`ServerFuncItem`](../interfaces/ServerFuncItem.md).[`params`](../interfaces/ServerFuncItem.md#params)
|
|
320
320
|
|
|
321
321
|
***
|
|
322
322
|
|
|
@@ -324,13 +324,13 @@ Parameter definitions, which can be an object mapping names to definitions or an
|
|
|
324
324
|
|
|
325
325
|
> `optional` **result**: `string` \| `Record`\<`string`, `any`\>
|
|
326
326
|
|
|
327
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:86](https://github.com/isdk/ai-tool.js/blob/
|
|
327
|
+
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)
|
|
328
328
|
|
|
329
329
|
The expected return type of the function, described as a string or a JSON schema object.
|
|
330
330
|
|
|
331
331
|
#### Inherited from
|
|
332
332
|
|
|
333
|
-
[`
|
|
333
|
+
[`ServerFuncItem`](../interfaces/ServerFuncItem.md).[`result`](../interfaces/ServerFuncItem.md#result)
|
|
334
334
|
|
|
335
335
|
***
|
|
336
336
|
|
|
@@ -338,21 +338,21 @@ The expected return type of the function, described as a string or a JSON schema
|
|
|
338
338
|
|
|
339
339
|
> `optional` **scope**: `any`
|
|
340
340
|
|
|
341
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:91](https://github.com/isdk/ai-tool.js/blob/
|
|
341
|
+
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)
|
|
342
342
|
|
|
343
343
|
The execution scope or context (`this`) for the function.
|
|
344
344
|
|
|
345
345
|
#### Inherited from
|
|
346
346
|
|
|
347
|
-
[`
|
|
347
|
+
[`ServerFuncItem`](../interfaces/ServerFuncItem.md).[`scope`](../interfaces/ServerFuncItem.md#scope)
|
|
348
348
|
|
|
349
349
|
***
|
|
350
350
|
|
|
351
351
|
### setup()?
|
|
352
352
|
|
|
353
|
-
> `optional` **setup**: (`this`, `options
|
|
353
|
+
> `optional` **setup**: (`this`, `options?`) => `void`
|
|
354
354
|
|
|
355
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:114](https://github.com/isdk/ai-tool.js/blob/
|
|
355
|
+
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)
|
|
356
356
|
|
|
357
357
|
A lifecycle hook called once during the `ToolFunc` instance's initialization.
|
|
358
358
|
It allows for initial setup, state configuration, or property modification on the instance
|
|
@@ -390,7 +390,7 @@ console.log(myFunc.customState); // Outputs: 'configured'
|
|
|
390
390
|
|
|
391
391
|
#### Inherited from
|
|
392
392
|
|
|
393
|
-
[`
|
|
393
|
+
[`ServerFuncItem`](../interfaces/ServerFuncItem.md).[`setup`](../interfaces/ServerFuncItem.md#setup)
|
|
394
394
|
|
|
395
395
|
***
|
|
396
396
|
|
|
@@ -398,14 +398,14 @@ console.log(myFunc.customState); // Outputs: 'configured'
|
|
|
398
398
|
|
|
399
399
|
> `optional` **stream**: `boolean`
|
|
400
400
|
|
|
401
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:125](https://github.com/isdk/ai-tool.js/blob/
|
|
401
|
+
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)
|
|
402
402
|
|
|
403
403
|
If true, indicates that the function has the *capability* to stream its output.
|
|
404
404
|
Whether a specific call is streamed is determined by a `stream` property in the runtime parameters.
|
|
405
405
|
|
|
406
406
|
#### Inherited from
|
|
407
407
|
|
|
408
|
-
[`
|
|
408
|
+
[`ServerFuncItem`](../interfaces/ServerFuncItem.md).[`stream`](../interfaces/ServerFuncItem.md#stream)
|
|
409
409
|
|
|
410
410
|
***
|
|
411
411
|
|
|
@@ -413,13 +413,13 @@ Whether a specific call is streamed is determined by a `stream` property in the
|
|
|
413
413
|
|
|
414
414
|
> `optional` **tags**: `string` \| `string`[]
|
|
415
415
|
|
|
416
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:96](https://github.com/isdk/ai-tool.js/blob/
|
|
416
|
+
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)
|
|
417
417
|
|
|
418
418
|
Tags for grouping or filtering functions.
|
|
419
419
|
|
|
420
420
|
#### Inherited from
|
|
421
421
|
|
|
422
|
-
[`
|
|
422
|
+
[`ServerFuncItem`](../interfaces/ServerFuncItem.md).[`tags`](../interfaces/ServerFuncItem.md#tags)
|
|
423
423
|
|
|
424
424
|
***
|
|
425
425
|
|
|
@@ -427,13 +427,13 @@ Tags for grouping or filtering functions.
|
|
|
427
427
|
|
|
428
428
|
> `optional` **title**: `string`
|
|
429
429
|
|
|
430
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:177](https://github.com/isdk/ai-tool.js/blob/
|
|
430
|
+
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)
|
|
431
431
|
|
|
432
432
|
A concise, human-readable title for the function, often used in UI or by AI.
|
|
433
433
|
|
|
434
434
|
#### Inherited from
|
|
435
435
|
|
|
436
|
-
[`
|
|
436
|
+
[`ServerFuncItem`](../interfaces/ServerFuncItem.md).[`title`](../interfaces/ServerFuncItem.md#title)
|
|
437
437
|
|
|
438
438
|
***
|
|
439
439
|
|
|
@@ -441,7 +441,7 @@ A concise, human-readable title for the function, often used in UI or by AI.
|
|
|
441
441
|
|
|
442
442
|
> `static` **aliases**: `object` = `{}`
|
|
443
443
|
|
|
444
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:305](https://github.com/isdk/ai-tool.js/blob/
|
|
444
|
+
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)
|
|
445
445
|
|
|
446
446
|
A static map of aliases to their corresponding function names.
|
|
447
447
|
|
|
@@ -459,7 +459,7 @@ A static map of aliases to their corresponding function names.
|
|
|
459
459
|
|
|
460
460
|
> `static` **dataPath**: `string`
|
|
461
461
|
|
|
462
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:312](https://github.com/isdk/ai-tool.js/blob/
|
|
462
|
+
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)
|
|
463
463
|
|
|
464
464
|
A conventional property to designate a file path for saving the registered `ToolFunc` data.
|
|
465
465
|
Note: The `ToolFunc` class itself does not implement persistence logic. It is up to the
|
|
@@ -475,7 +475,7 @@ developer to use this path to save and load the `ToolFunc.items` registry if nee
|
|
|
475
475
|
|
|
476
476
|
> `static` **items**: [`Funcs`](../interfaces/Funcs.md) = `{}`
|
|
477
477
|
|
|
478
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:300](https://github.com/isdk/ai-tool.js/blob/
|
|
478
|
+
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)
|
|
479
479
|
|
|
480
480
|
A static registry of all `ToolFunc` instances, indexed by name.
|
|
481
481
|
|
|
@@ -491,7 +491,7 @@ A static registry of all `ToolFunc` instances, indexed by name.
|
|
|
491
491
|
|
|
492
492
|
> **get** `static` **apiRoot**(): `undefined` \| `string`
|
|
493
493
|
|
|
494
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:57](https://github.com/isdk/ai-tool.js/blob/
|
|
494
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:57](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/server-tools.ts#L57)
|
|
495
495
|
|
|
496
496
|
The conventional root path for the API endpoint.
|
|
497
497
|
|
|
@@ -509,7 +509,7 @@ The conventional root path for the API endpoint.
|
|
|
509
509
|
|
|
510
510
|
> **arr2ObjParams**(`params`): `any`[]
|
|
511
511
|
|
|
512
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:629](https://github.com/isdk/ai-tool.js/blob/
|
|
512
|
+
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)
|
|
513
513
|
|
|
514
514
|
Converts an array of positional arguments into a named parameters object.
|
|
515
515
|
This is used internally to support functions defined with named parameters.
|
|
@@ -536,7 +536,7 @@ An array containing a single parameters object.
|
|
|
536
536
|
|
|
537
537
|
### assign()
|
|
538
538
|
|
|
539
|
-
> **assign**(`src`, `options
|
|
539
|
+
> **assign**(`src`, `options?`): `this`
|
|
540
540
|
|
|
541
541
|
Defined in: [property-manager.js/src/abstract.d.ts:106](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L106)
|
|
542
542
|
|
|
@@ -568,7 +568,7 @@ this object
|
|
|
568
568
|
|
|
569
569
|
### assignProperty()
|
|
570
570
|
|
|
571
|
-
> **assignProperty**(`src`, `name`, `value`, `attrs
|
|
571
|
+
> **assignProperty**(`src`, `name`, `value`, `attrs?`, `options?`): `void`
|
|
572
572
|
|
|
573
573
|
Defined in: [property-manager.js/src/abstract.d.ts:117](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L117)
|
|
574
574
|
|
|
@@ -616,7 +616,7 @@ the attributes object
|
|
|
616
616
|
|
|
617
617
|
### assignPropertyTo()
|
|
618
618
|
|
|
619
|
-
> `abstract` **assignPropertyTo**(`dest`, `src`, `name`, `value`, `attrs
|
|
619
|
+
> `abstract` **assignPropertyTo**(`dest`, `src`, `name`, `value`, `attrs?`, `options?`): `void`
|
|
620
620
|
|
|
621
621
|
Defined in: [property-manager.js/src/abstract.d.ts:131](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L131)
|
|
622
622
|
|
|
@@ -670,7 +670,7 @@ The attributes object of the property
|
|
|
670
670
|
|
|
671
671
|
### assignTo()
|
|
672
672
|
|
|
673
|
-
> **assignTo**(`dest
|
|
673
|
+
> **assignTo**(`dest?`, `options?`): `any`
|
|
674
674
|
|
|
675
675
|
Defined in: [property-manager.js/src/abstract.d.ts:191](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L191)
|
|
676
676
|
|
|
@@ -702,7 +702,7 @@ the dest object
|
|
|
702
702
|
|
|
703
703
|
### clone()
|
|
704
704
|
|
|
705
|
-
> **clone**(`options
|
|
705
|
+
> **clone**(`options?`): `any`
|
|
706
706
|
|
|
707
707
|
Defined in: [property-manager.js/src/abstract.d.ts:155](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L155)
|
|
708
708
|
|
|
@@ -728,7 +728,7 @@ the new object
|
|
|
728
728
|
|
|
729
729
|
### cloneTo()
|
|
730
730
|
|
|
731
|
-
> **cloneTo**(`dest`, `options
|
|
731
|
+
> **cloneTo**(`dest`, `options?`): `any`
|
|
732
732
|
|
|
733
733
|
Defined in: [property-manager.js/src/abstract.d.ts:148](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L148)
|
|
734
734
|
|
|
@@ -786,7 +786,7 @@ the defined attributes of the object
|
|
|
786
786
|
|
|
787
787
|
### exportTo()
|
|
788
788
|
|
|
789
|
-
> **exportTo**(`dest`, `options
|
|
789
|
+
> **exportTo**(`dest`, `options?`): `any`
|
|
790
790
|
|
|
791
791
|
Defined in: [property-manager.js/src/abstract.d.ts:173](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L173)
|
|
792
792
|
|
|
@@ -820,7 +820,7 @@ the dest object.
|
|
|
820
820
|
|
|
821
821
|
> **func**(`params`): `any`
|
|
822
822
|
|
|
823
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:112](https://github.com/isdk/ai-tool.js/blob/
|
|
823
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:112](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/server-tools.ts#L112)
|
|
824
824
|
|
|
825
825
|
Placeholder for the actual server-side function implementation.
|
|
826
826
|
This method is intended to be defined when a `ServerTools` instance is created.
|
|
@@ -847,9 +847,9 @@ The result of the function.
|
|
|
847
847
|
|
|
848
848
|
### getFunc()
|
|
849
849
|
|
|
850
|
-
> **getFunc**(`name
|
|
850
|
+
> **getFunc**(`name?`): `any`
|
|
851
851
|
|
|
852
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:720](https://github.com/isdk/ai-tool.js/blob/
|
|
852
|
+
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)
|
|
853
853
|
|
|
854
854
|
Gets a bound function reference for execution with named parameters.
|
|
855
855
|
If a name is provided, it retrieves a different function from the registry.
|
|
@@ -877,9 +877,9 @@ A function reference or `undefined` if not found.
|
|
|
877
877
|
|
|
878
878
|
### getFuncWithPos()
|
|
879
879
|
|
|
880
|
-
> **getFuncWithPos**(`name
|
|
880
|
+
> **getFuncWithPos**(`name?`): `any`
|
|
881
881
|
|
|
882
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:777](https://github.com/isdk/ai-tool.js/blob/
|
|
882
|
+
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)
|
|
883
883
|
|
|
884
884
|
Gets a bound function reference suitable for positional argument execution.
|
|
885
885
|
If a name is provided, it retrieves a different function from the registry.
|
|
@@ -929,7 +929,7 @@ the descriptors of properties object
|
|
|
929
929
|
|
|
930
930
|
> **hasAsyncFeature**(`feature`): `boolean`
|
|
931
931
|
|
|
932
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:787](https://github.com/isdk/ai-tool.js/blob/
|
|
932
|
+
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)
|
|
933
933
|
|
|
934
934
|
Checks if the current function instance supports a specific async feature.
|
|
935
935
|
|
|
@@ -981,7 +981,7 @@ A property name.
|
|
|
981
981
|
|
|
982
982
|
### initialize()
|
|
983
983
|
|
|
984
|
-
> **initialize**(`src
|
|
984
|
+
> **initialize**(`src?`): `this`
|
|
985
985
|
|
|
986
986
|
Defined in: [property-manager.js/src/abstract.d.ts:139](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L139)
|
|
987
987
|
|
|
@@ -1033,7 +1033,7 @@ Another object whose prototype chain is to be checked.
|
|
|
1033
1033
|
|
|
1034
1034
|
### isSame()
|
|
1035
1035
|
|
|
1036
|
-
> **isSame**(`src`, `options
|
|
1036
|
+
> **isSame**(`src`, `options?`): `boolean`
|
|
1037
1037
|
|
|
1038
1038
|
Defined in: [property-manager.js/src/abstract.d.ts:200](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L200)
|
|
1039
1039
|
|
|
@@ -1065,7 +1065,7 @@ The source object
|
|
|
1065
1065
|
|
|
1066
1066
|
> **isStream**(`params`): `undefined` \| `boolean`
|
|
1067
1067
|
|
|
1068
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:805](https://github.com/isdk/ai-tool.js/blob/
|
|
1068
|
+
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)
|
|
1069
1069
|
|
|
1070
1070
|
Determines if a function call should produce a stream.
|
|
1071
1071
|
|
|
@@ -1097,7 +1097,7 @@ The runtime parameters passed to the function call.
|
|
|
1097
1097
|
|
|
1098
1098
|
### mergeTo()
|
|
1099
1099
|
|
|
1100
|
-
> **mergeTo**(`dest`, `options
|
|
1100
|
+
> **mergeTo**(`dest`, `options?`): `any`
|
|
1101
1101
|
|
|
1102
1102
|
Defined in: [property-manager.js/src/abstract.d.ts:164](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L164)
|
|
1103
1103
|
|
|
@@ -1129,9 +1129,9 @@ the dest object.
|
|
|
1129
1129
|
|
|
1130
1130
|
### obj2ArrParams()
|
|
1131
1131
|
|
|
1132
|
-
> **obj2ArrParams**(`params
|
|
1132
|
+
> **obj2ArrParams**(`params?`): `any`[]
|
|
1133
1133
|
|
|
1134
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:648](https://github.com/isdk/ai-tool.js/blob/
|
|
1134
|
+
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)
|
|
1135
1135
|
|
|
1136
1136
|
Converts a named parameters object into an array of positional arguments.
|
|
1137
1137
|
This is used for functions defined with positional parameters.
|
|
@@ -1186,7 +1186,7 @@ A property name.
|
|
|
1186
1186
|
|
|
1187
1187
|
> **register**(): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
1188
1188
|
|
|
1189
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:602](https://github.com/isdk/ai-tool.js/blob/
|
|
1189
|
+
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)
|
|
1190
1190
|
|
|
1191
1191
|
Registers the current `ToolFunc` instance into the static registry.
|
|
1192
1192
|
Also registers any declared dependencies.
|
|
@@ -1205,9 +1205,9 @@ The instance itself upon successful registration, or `false` if it already exist
|
|
|
1205
1205
|
|
|
1206
1206
|
### run()
|
|
1207
1207
|
|
|
1208
|
-
> **run**(`params`, `context
|
|
1208
|
+
> **run**(`params`, `context?`): `Promise`\<`any`\>
|
|
1209
1209
|
|
|
1210
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:98](https://github.com/isdk/ai-tool.js/blob/
|
|
1210
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:98](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/server-tools.ts#L98)
|
|
1211
1211
|
|
|
1212
1212
|
Overrides the base `run` method to inject transport-specific context.
|
|
1213
1213
|
If a `context` object containing `req` and `reply` is provided, these are
|
|
@@ -1247,9 +1247,9 @@ The result of the function execution.
|
|
|
1247
1247
|
|
|
1248
1248
|
### runAs()
|
|
1249
1249
|
|
|
1250
|
-
> **runAs**(`name`, `params
|
|
1250
|
+
> **runAs**(`name`, `params?`): `Promise`\<`any`\>
|
|
1251
1251
|
|
|
1252
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:697](https://github.com/isdk/ai-tool.js/blob/
|
|
1252
|
+
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)
|
|
1253
1253
|
|
|
1254
1254
|
Asynchronously executes another registered function by name.
|
|
1255
1255
|
This method delegates to `runAsSync()` internally.
|
|
@@ -1282,9 +1282,9 @@ A promise that resolves with the result of the function execution.
|
|
|
1282
1282
|
|
|
1283
1283
|
### runAsSync()
|
|
1284
1284
|
|
|
1285
|
-
> **runAsSync**(`name`, `params
|
|
1285
|
+
> **runAsSync**(`name`, `params?`): `any`
|
|
1286
1286
|
|
|
1287
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:708](https://github.com/isdk/ai-tool.js/blob/
|
|
1287
|
+
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)
|
|
1288
1288
|
|
|
1289
1289
|
Synchronously executes another registered function by name.
|
|
1290
1290
|
This is a convenience method that forwards the call to the static `runSync()` method.
|
|
@@ -1317,9 +1317,9 @@ The result of the function execution.
|
|
|
1317
1317
|
|
|
1318
1318
|
### runSync()
|
|
1319
1319
|
|
|
1320
|
-
> **runSync**(`params
|
|
1320
|
+
> **runSync**(`params?`): `any`
|
|
1321
1321
|
|
|
1322
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:667](https://github.com/isdk/ai-tool.js/blob/
|
|
1322
|
+
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)
|
|
1323
1323
|
|
|
1324
1324
|
Executes the function synchronously with a named parameters object.
|
|
1325
1325
|
|
|
@@ -1351,7 +1351,7 @@ Will throw an error if an array of parameters is passed to a function that expec
|
|
|
1351
1351
|
|
|
1352
1352
|
> **runWithPos**(...`params`): `Promise`\<`any`\>
|
|
1353
1353
|
|
|
1354
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:755](https://github.com/isdk/ai-tool.js/blob/
|
|
1354
|
+
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)
|
|
1355
1355
|
|
|
1356
1356
|
Executes the function asynchronously using positional arguments.
|
|
1357
1357
|
Delegates to `runWithPosSync()` internally.
|
|
@@ -1380,7 +1380,7 @@ A promise that resolves with the result of the function execution.
|
|
|
1380
1380
|
|
|
1381
1381
|
> **runWithPosAs**(`name`, ...`params`): `Promise`\<`any`\>
|
|
1382
1382
|
|
|
1383
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:766](https://github.com/isdk/ai-tool.js/blob/
|
|
1383
|
+
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)
|
|
1384
1384
|
|
|
1385
1385
|
Asynchronously executes another function by name using positional arguments.
|
|
1386
1386
|
Delegates to `runWithPosAsSync()` internally.
|
|
@@ -1415,7 +1415,7 @@ A promise that resolves with the result of the function execution.
|
|
|
1415
1415
|
|
|
1416
1416
|
> **runWithPosAsSync**(`name`, ...`params`): `any`
|
|
1417
1417
|
|
|
1418
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:745](https://github.com/isdk/ai-tool.js/blob/
|
|
1418
|
+
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)
|
|
1419
1419
|
|
|
1420
1420
|
Synchronously executes another function by name using positional arguments.
|
|
1421
1421
|
This is a convenience wrapper around the static `runWithPosSync()` method.
|
|
@@ -1450,7 +1450,7 @@ The result of the function execution.
|
|
|
1450
1450
|
|
|
1451
1451
|
> **runWithPosSync**(...`params`): `any`
|
|
1452
1452
|
|
|
1453
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:731](https://github.com/isdk/ai-tool.js/blob/
|
|
1453
|
+
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)
|
|
1454
1454
|
|
|
1455
1455
|
Executes the function synchronously using positional arguments.
|
|
1456
1456
|
If the function expects named parameters, it converts the arguments automatically.
|
|
@@ -1511,7 +1511,7 @@ Returns a date converted to a string using the current locale.
|
|
|
1511
1511
|
|
|
1512
1512
|
### toObject()
|
|
1513
1513
|
|
|
1514
|
-
> **toObject**(`options
|
|
1514
|
+
> **toObject**(`options?`): `any`
|
|
1515
1515
|
|
|
1516
1516
|
Defined in: [property-manager.js/src/abstract.d.ts:181](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L181)
|
|
1517
1517
|
|
|
@@ -1557,7 +1557,7 @@ Returns a string representation of an object.
|
|
|
1557
1557
|
|
|
1558
1558
|
> **unregister**(): `any`
|
|
1559
1559
|
|
|
1560
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:619](https://github.com/isdk/ai-tool.js/blob/
|
|
1560
|
+
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)
|
|
1561
1561
|
|
|
1562
1562
|
Removes the current `ToolFunc` instance from the static registry.
|
|
1563
1563
|
|
|
@@ -1604,9 +1604,13 @@ target object. Returns the target object.
|
|
|
1604
1604
|
|
|
1605
1605
|
##### Type Parameters
|
|
1606
1606
|
|
|
1607
|
-
|
|
1607
|
+
###### T
|
|
1608
1608
|
|
|
1609
|
-
|
|
1609
|
+
`T` *extends* `object`
|
|
1610
|
+
|
|
1611
|
+
###### U
|
|
1612
|
+
|
|
1613
|
+
`U`
|
|
1610
1614
|
|
|
1611
1615
|
##### Parameters
|
|
1612
1616
|
|
|
@@ -1641,11 +1645,17 @@ target object. Returns the target object.
|
|
|
1641
1645
|
|
|
1642
1646
|
##### Type Parameters
|
|
1643
1647
|
|
|
1644
|
-
|
|
1648
|
+
###### T
|
|
1649
|
+
|
|
1650
|
+
`T` *extends* `object`
|
|
1651
|
+
|
|
1652
|
+
###### U
|
|
1653
|
+
|
|
1654
|
+
`U`
|
|
1645
1655
|
|
|
1646
|
-
|
|
1656
|
+
###### V
|
|
1647
1657
|
|
|
1648
|
-
|
|
1658
|
+
`V`
|
|
1649
1659
|
|
|
1650
1660
|
##### Parameters
|
|
1651
1661
|
|
|
@@ -1686,13 +1696,21 @@ target object. Returns the target object.
|
|
|
1686
1696
|
|
|
1687
1697
|
##### Type Parameters
|
|
1688
1698
|
|
|
1689
|
-
|
|
1699
|
+
###### T
|
|
1690
1700
|
|
|
1691
|
-
|
|
1701
|
+
`T` *extends* `object`
|
|
1692
1702
|
|
|
1693
|
-
|
|
1703
|
+
###### U
|
|
1704
|
+
|
|
1705
|
+
`U`
|
|
1706
|
+
|
|
1707
|
+
###### V
|
|
1708
|
+
|
|
1709
|
+
`V`
|
|
1694
1710
|
|
|
1695
|
-
|
|
1711
|
+
###### W
|
|
1712
|
+
|
|
1713
|
+
`W`
|
|
1696
1714
|
|
|
1697
1715
|
##### Parameters
|
|
1698
1716
|
|
|
@@ -1821,7 +1839,7 @@ JavaScript object that contains one or more property descriptors.
|
|
|
1821
1839
|
|
|
1822
1840
|
### defineProperties()
|
|
1823
1841
|
|
|
1824
|
-
> `static` **defineProperties**(`aTarget`, `aProperties`, `recreate
|
|
1842
|
+
> `static` **defineProperties**(`aTarget`, `aProperties`, `recreate?`): `any`
|
|
1825
1843
|
|
|
1826
1844
|
Defined in: [property-manager.js/src/advance.d.ts:11](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/advance.d.ts#L11)
|
|
1827
1845
|
|
|
@@ -1861,7 +1879,9 @@ Adds a property to an object, or modifies attributes of an existing property.
|
|
|
1861
1879
|
|
|
1862
1880
|
#### Type Parameters
|
|
1863
1881
|
|
|
1864
|
-
|
|
1882
|
+
##### T
|
|
1883
|
+
|
|
1884
|
+
`T`
|
|
1865
1885
|
|
|
1866
1886
|
#### Parameters
|
|
1867
1887
|
|
|
@@ -1905,7 +1925,9 @@ Returns an array of key/values of the enumerable own properties of an object
|
|
|
1905
1925
|
|
|
1906
1926
|
##### Type Parameters
|
|
1907
1927
|
|
|
1908
|
-
|
|
1928
|
+
###### T
|
|
1929
|
+
|
|
1930
|
+
`T`
|
|
1909
1931
|
|
|
1910
1932
|
##### Parameters
|
|
1911
1933
|
|
|
@@ -1913,7 +1935,7 @@ Returns an array of key/values of the enumerable own properties of an object
|
|
|
1913
1935
|
|
|
1914
1936
|
Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.
|
|
1915
1937
|
|
|
1916
|
-
\{\} | `ArrayLike`\<`T`\>
|
|
1938
|
+
\{\[`s`: `string`\]: `T`; \} | `ArrayLike`\<`T`\>
|
|
1917
1939
|
|
|
1918
1940
|
##### Returns
|
|
1919
1941
|
|
|
@@ -1959,7 +1981,9 @@ Prevents the modification of existing property attributes and values, and preven
|
|
|
1959
1981
|
|
|
1960
1982
|
##### Type Parameters
|
|
1961
1983
|
|
|
1962
|
-
|
|
1984
|
+
###### T
|
|
1985
|
+
|
|
1986
|
+
`T` *extends* `Function`
|
|
1963
1987
|
|
|
1964
1988
|
##### Parameters
|
|
1965
1989
|
|
|
@@ -1987,9 +2011,13 @@ Prevents the modification of existing property attributes and values, and preven
|
|
|
1987
2011
|
|
|
1988
2012
|
##### Type Parameters
|
|
1989
2013
|
|
|
1990
|
-
|
|
2014
|
+
###### T
|
|
2015
|
+
|
|
2016
|
+
`T` *extends* `object`
|
|
1991
2017
|
|
|
1992
|
-
|
|
2018
|
+
###### U
|
|
2019
|
+
|
|
2020
|
+
`U` *extends* `string` \| `number` \| `bigint` \| `boolean` \| `symbol`
|
|
1993
2021
|
|
|
1994
2022
|
##### Parameters
|
|
1995
2023
|
|
|
@@ -2017,7 +2045,9 @@ Prevents the modification of existing property attributes and values, and preven
|
|
|
2017
2045
|
|
|
2018
2046
|
##### Type Parameters
|
|
2019
2047
|
|
|
2020
|
-
|
|
2048
|
+
###### T
|
|
2049
|
+
|
|
2050
|
+
`T`
|
|
2021
2051
|
|
|
2022
2052
|
##### Parameters
|
|
2023
2053
|
|
|
@@ -2049,7 +2079,9 @@ Returns an object created by key-value entries for properties and methods
|
|
|
2049
2079
|
|
|
2050
2080
|
##### Type Parameters
|
|
2051
2081
|
|
|
2052
|
-
|
|
2082
|
+
###### T
|
|
2083
|
+
|
|
2084
|
+
`T` = `any`
|
|
2053
2085
|
|
|
2054
2086
|
##### Parameters
|
|
2055
2087
|
|
|
@@ -2097,7 +2129,7 @@ An iterable object that contains key-value entries for properties and methods.
|
|
|
2097
2129
|
|
|
2098
2130
|
> `static` **get**(`name`): [`ToolFunc`](ToolFunc.md)
|
|
2099
2131
|
|
|
2100
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:319](https://github.com/isdk/ai-tool.js/blob/
|
|
2132
|
+
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)
|
|
2101
2133
|
|
|
2102
2134
|
Retrieves a registered function by its name or alias.
|
|
2103
2135
|
|
|
@@ -2125,7 +2157,7 @@ The `ToolFunc` instance if found, otherwise `undefined`.
|
|
|
2125
2157
|
|
|
2126
2158
|
> `static` **getAllByTag**(`tagName`): [`ToolFunc`](ToolFunc.md)[]
|
|
2127
2159
|
|
|
2128
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:365](https://github.com/isdk/ai-tool.js/blob/
|
|
2160
|
+
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)
|
|
2129
2161
|
|
|
2130
2162
|
Retrieves all registered functions that have a specific tag.
|
|
2131
2163
|
|
|
@@ -2153,7 +2185,7 @@ An array of matching `ToolFunc` instances.
|
|
|
2153
2185
|
|
|
2154
2186
|
> `static` **getByTag**(`tagName`): `undefined` \| [`ToolFunc`](ToolFunc.md)
|
|
2155
2187
|
|
|
2156
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:340](https://github.com/isdk/ai-tool.js/blob/
|
|
2188
|
+
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)
|
|
2157
2189
|
|
|
2158
2190
|
Finds the first registered function that has a specific tag.
|
|
2159
2191
|
|
|
@@ -2181,7 +2213,7 @@ The first matching `ToolFunc` instance, or `undefined` if none is found.
|
|
|
2181
2213
|
|
|
2182
2214
|
> `static` **getFunc**(`name`): `any`
|
|
2183
2215
|
|
|
2184
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:431](https://github.com/isdk/ai-tool.js/blob/
|
|
2216
|
+
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)
|
|
2185
2217
|
|
|
2186
2218
|
Retrieves a bound, runnable function reference for a registered function.
|
|
2187
2219
|
This reference is suitable for execution with an object of named parameters.
|
|
@@ -2210,7 +2242,7 @@ A bound function reference, or `undefined` if not found.
|
|
|
2210
2242
|
|
|
2211
2243
|
> `static` **getFuncWithPos**(`name`): `any`
|
|
2212
2244
|
|
|
2213
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:472](https://github.com/isdk/ai-tool.js/blob/
|
|
2245
|
+
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)
|
|
2214
2246
|
|
|
2215
2247
|
Retrieves a bound, runnable function reference for a registered function.
|
|
2216
2248
|
This reference is suitable for execution with positional arguments.
|
|
@@ -2278,7 +2310,9 @@ Returns an object containing all own property descriptors of an object
|
|
|
2278
2310
|
|
|
2279
2311
|
#### Type Parameters
|
|
2280
2312
|
|
|
2281
|
-
|
|
2313
|
+
##### T
|
|
2314
|
+
|
|
2315
|
+
`T`
|
|
2282
2316
|
|
|
2283
2317
|
#### Parameters
|
|
2284
2318
|
|
|
@@ -2399,7 +2433,7 @@ The object that references the prototype.
|
|
|
2399
2433
|
|
|
2400
2434
|
> `static` **hasAsyncFeature**(`feature`): `boolean`
|
|
2401
2435
|
|
|
2402
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:388](https://github.com/isdk/ai-tool.js/blob/
|
|
2436
|
+
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)
|
|
2403
2437
|
|
|
2404
2438
|
Checks if any registered function has a specific asynchronous feature.
|
|
2405
2439
|
|
|
@@ -2619,7 +2653,7 @@ Object that contains the properties and methods. This can be an object that you
|
|
|
2619
2653
|
|
|
2620
2654
|
> `static` **list**(): [`Funcs`](../interfaces/Funcs.md)
|
|
2621
2655
|
|
|
2622
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:331](https://github.com/isdk/ai-tool.js/blob/
|
|
2656
|
+
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)
|
|
2623
2657
|
|
|
2624
2658
|
Returns the complete map of all registered functions.
|
|
2625
2659
|
|
|
@@ -2645,7 +2679,9 @@ Prevents the addition of new properties to an object.
|
|
|
2645
2679
|
|
|
2646
2680
|
#### Type Parameters
|
|
2647
2681
|
|
|
2648
|
-
|
|
2682
|
+
##### T
|
|
2683
|
+
|
|
2684
|
+
`T`
|
|
2649
2685
|
|
|
2650
2686
|
#### Parameters
|
|
2651
2687
|
|
|
@@ -2671,7 +2707,7 @@ Object to make non-extensible.
|
|
|
2671
2707
|
|
|
2672
2708
|
> `static` **register**(`name`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2673
2709
|
|
|
2674
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:495](https://github.com/isdk/ai-tool.js/blob/
|
|
2710
|
+
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)
|
|
2675
2711
|
|
|
2676
2712
|
Registers a new tool function.
|
|
2677
2713
|
|
|
@@ -2695,10 +2731,6 @@ The function's configuration.
|
|
|
2695
2731
|
|
|
2696
2732
|
The new `ToolFunc` instance, or `false` if a function with that name already exists.
|
|
2697
2733
|
|
|
2698
|
-
The new `ToolFunc` instance, or `false` if a function with that name already exists.
|
|
2699
|
-
|
|
2700
|
-
The new `ToolFunc` instance, or `false` if a function with that name already exists.
|
|
2701
|
-
|
|
2702
2734
|
##### Inherited from
|
|
2703
2735
|
|
|
2704
2736
|
[`ToolFunc`](ToolFunc.md).[`register`](ToolFunc.md#register-2)
|
|
@@ -2707,7 +2739,7 @@ The new `ToolFunc` instance, or `false` if a function with that name already exi
|
|
|
2707
2739
|
|
|
2708
2740
|
> `static` **register**(`func`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2709
2741
|
|
|
2710
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:496](https://github.com/isdk/ai-tool.js/blob/
|
|
2742
|
+
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)
|
|
2711
2743
|
|
|
2712
2744
|
Registers a new tool function.
|
|
2713
2745
|
|
|
@@ -2731,19 +2763,15 @@ The function's configuration.
|
|
|
2731
2763
|
|
|
2732
2764
|
The new `ToolFunc` instance, or `false` if a function with that name already exists.
|
|
2733
2765
|
|
|
2734
|
-
The new `ToolFunc` instance, or `false` if a function with that name already exists.
|
|
2735
|
-
|
|
2736
|
-
The new `ToolFunc` instance, or `false` if a function with that name already exists.
|
|
2737
|
-
|
|
2738
2766
|
##### Inherited from
|
|
2739
2767
|
|
|
2740
2768
|
[`ToolFunc`](ToolFunc.md).[`register`](ToolFunc.md#register-2)
|
|
2741
2769
|
|
|
2742
2770
|
#### Call Signature
|
|
2743
2771
|
|
|
2744
|
-
> `static` **register**(`name`, `options
|
|
2772
|
+
> `static` **register**(`name`, `options?`): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2745
2773
|
|
|
2746
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:497](https://github.com/isdk/ai-tool.js/blob/
|
|
2774
|
+
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)
|
|
2747
2775
|
|
|
2748
2776
|
Registers a new tool function.
|
|
2749
2777
|
|
|
@@ -2767,10 +2795,6 @@ The function's configuration.
|
|
|
2767
2795
|
|
|
2768
2796
|
The new `ToolFunc` instance, or `false` if a function with that name already exists.
|
|
2769
2797
|
|
|
2770
|
-
The new `ToolFunc` instance, or `false` if a function with that name already exists.
|
|
2771
|
-
|
|
2772
|
-
The new `ToolFunc` instance, or `false` if a function with that name already exists.
|
|
2773
|
-
|
|
2774
2798
|
##### Inherited from
|
|
2775
2799
|
|
|
2776
2800
|
[`ToolFunc`](ToolFunc.md).[`register`](ToolFunc.md#register-2)
|
|
@@ -2779,9 +2803,9 @@ The new `ToolFunc` instance, or `false` if a function with that name already exi
|
|
|
2779
2803
|
|
|
2780
2804
|
### run()
|
|
2781
2805
|
|
|
2782
|
-
> `static` **run**(`name`, `params
|
|
2806
|
+
> `static` **run**(`name`, `params?`): `Promise`\<`any`\>
|
|
2783
2807
|
|
|
2784
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:402](https://github.com/isdk/ai-tool.js/blob/
|
|
2808
|
+
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)
|
|
2785
2809
|
|
|
2786
2810
|
Asynchronously executes a registered function by name with named parameters.
|
|
2787
2811
|
|
|
@@ -2817,9 +2841,9 @@ If the function with the given name is not found.
|
|
|
2817
2841
|
|
|
2818
2842
|
### runSync()
|
|
2819
2843
|
|
|
2820
|
-
> `static` **runSync**(`name`, `params
|
|
2844
|
+
> `static` **runSync**(`name`, `params?`): `any`
|
|
2821
2845
|
|
|
2822
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:417](https://github.com/isdk/ai-tool.js/blob/
|
|
2846
|
+
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)
|
|
2823
2847
|
|
|
2824
2848
|
Synchronously executes a registered function by name with named parameters.
|
|
2825
2849
|
|
|
@@ -2857,7 +2881,7 @@ If the function with the given name is not found.
|
|
|
2857
2881
|
|
|
2858
2882
|
> `static` **runWithPos**(`name`, ...`params`): `Promise`\<`any`\>
|
|
2859
2883
|
|
|
2860
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:443](https://github.com/isdk/ai-tool.js/blob/
|
|
2884
|
+
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)
|
|
2861
2885
|
|
|
2862
2886
|
Asynchronously executes a function using positional arguments.
|
|
2863
2887
|
|
|
@@ -2895,7 +2919,7 @@ If the function with the given name is not found.
|
|
|
2895
2919
|
|
|
2896
2920
|
> `static` **runWithPosSync**(`name`, ...`params`): `any`
|
|
2897
2921
|
|
|
2898
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:458](https://github.com/isdk/ai-tool.js/blob/
|
|
2922
|
+
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)
|
|
2899
2923
|
|
|
2900
2924
|
Synchronously executes a function using positional arguments.
|
|
2901
2925
|
|
|
@@ -2939,7 +2963,9 @@ Prevents the modification of attributes of existing properties, and prevents the
|
|
|
2939
2963
|
|
|
2940
2964
|
#### Type Parameters
|
|
2941
2965
|
|
|
2942
|
-
|
|
2966
|
+
##### T
|
|
2967
|
+
|
|
2968
|
+
`T`
|
|
2943
2969
|
|
|
2944
2970
|
#### Parameters
|
|
2945
2971
|
|
|
@@ -2963,7 +2989,7 @@ Object on which to lock the attributes.
|
|
|
2963
2989
|
|
|
2964
2990
|
> `static` **setApiRoot**(`v`): `void`
|
|
2965
2991
|
|
|
2966
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:61](https://github.com/isdk/ai-tool.js/blob/
|
|
2992
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:61](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/server-tools.ts#L61)
|
|
2967
2993
|
|
|
2968
2994
|
#### Parameters
|
|
2969
2995
|
|
|
@@ -3013,7 +3039,7 @@ The value of the new prototype or null.
|
|
|
3013
3039
|
|
|
3014
3040
|
> `static` **toJSON**(): `object`
|
|
3015
3041
|
|
|
3016
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:74](https://github.com/isdk/ai-tool.js/blob/
|
|
3042
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:74](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/server-tools.ts#L74)
|
|
3017
3043
|
|
|
3018
3044
|
Serializes all registered `ServerTools` instances into a JSON object.
|
|
3019
3045
|
This method is typically called by a transport's discovery endpoint.
|
|
@@ -3033,7 +3059,7 @@ A map of serializable tool definitions.
|
|
|
3033
3059
|
|
|
3034
3060
|
> `static` **unregister**(`name`): `undefined` \| [`ToolFunc`](ToolFunc.md)
|
|
3035
3061
|
|
|
3036
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:547](https://github.com/isdk/ai-tool.js/blob/
|
|
3062
|
+
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)
|
|
3037
3063
|
|
|
3038
3064
|
Unregisters a function by its name, also removing any associated aliases.
|
|
3039
3065
|
|
|
@@ -3069,7 +3095,9 @@ Returns an array of values of the enumerable own properties of an object
|
|
|
3069
3095
|
|
|
3070
3096
|
##### Type Parameters
|
|
3071
3097
|
|
|
3072
|
-
|
|
3098
|
+
###### T
|
|
3099
|
+
|
|
3100
|
+
`T`
|
|
3073
3101
|
|
|
3074
3102
|
##### Parameters
|
|
3075
3103
|
|
|
@@ -3077,7 +3105,7 @@ Returns an array of values of the enumerable own properties of an object
|
|
|
3077
3105
|
|
|
3078
3106
|
Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.
|
|
3079
3107
|
|
|
3080
|
-
\{\} | `ArrayLike`\<`T`\>
|
|
3108
|
+
\{\[`s`: `string`\]: `T`; \} | `ArrayLike`\<`T`\>
|
|
3081
3109
|
|
|
3082
3110
|
##### Returns
|
|
3083
3111
|
|