@isdk/ai-tool 0.5.8 → 0.7.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/README.cn.md +103 -237
- package/README.md +101 -186
- package/dist/chunk-LNTIQQNN.mjs +1 -0
- package/dist/chunk-VIG2GB47.mjs +1 -1
- package/dist/funcs.d.mts +1 -1
- package/dist/funcs.d.ts +1 -1
- package/dist/funcs.js +1 -1
- package/dist/funcs.mjs +1 -1
- package/dist/index-BCco-g_I.d.mts +1781 -0
- package/dist/index-BCco-g_I.d.ts +1781 -0
- package/dist/index.d.mts +1083 -650
- package/dist/index.d.ts +1083 -650
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/dist/test/util.js +1 -1
- package/docs/api/README.md +165 -0
- package/docs/{_media → api/_media}/CONTRIBUTING.md +3 -3
- package/docs/api/_media/pubsub.md +326 -0
- package/docs/api/_media/server_client_tools.md +88 -0
- package/docs/api/_media/toolFunc.md +183 -0
- package/docs/api/_media/transport.md +137 -0
- package/docs/{classes → api/classes}/AbortError.md +139 -54
- package/docs/api/classes/AlreadyExistsError.md +431 -0
- package/docs/api/classes/BaseError.md +440 -0
- package/docs/{classes → api/classes}/BinarySemaphore.md +25 -25
- package/docs/{classes → api/classes}/CancelableAbility.md +25 -25
- package/docs/api/classes/ClientToolTransport.md +310 -0
- package/docs/{classes → api/classes}/ClientTools.md +642 -180
- package/docs/{classes → api/classes}/CommonError.md +139 -54
- package/docs/api/classes/ConfigFile.md +218 -0
- package/docs/{classes → api/classes}/EnvPromptTemplate.md +308 -65
- package/docs/{classes → api/classes}/EventClient.md +725 -232
- package/docs/{classes → api/classes}/EventEmitter.md +12 -12
- package/docs/{classes → api/classes}/EventServer.md +658 -205
- package/docs/{classes → api/classes}/EventToolFunc.md +561 -109
- package/docs/{classes → api/classes}/FStringPromptTemplate.md +309 -66
- package/docs/{classes → api/classes}/FewShotPromptTemplate.md +290 -63
- package/docs/{classes → api/classes}/GolangPromptTemplate.md +308 -65
- package/docs/api/classes/HttpClientToolTransport.md +324 -0
- package/docs/api/classes/HttpServerToolTransport.md +324 -0
- package/docs/{classes → api/classes}/IntSet.md +12 -12
- package/docs/{classes → api/classes}/LRUCache.md +26 -26
- package/docs/api/classes/NotFoundError.md +431 -0
- package/docs/api/classes/NotImplementationError.md +431 -0
- package/docs/{classes → api/classes}/PromptExampleSelector.md +9 -9
- package/docs/{classes → api/classes}/PromptTemplate.md +303 -63
- package/docs/api/classes/ReadableStreamError.md +451 -0
- package/docs/api/classes/ResClientTools.md +2878 -0
- package/docs/api/classes/ResServerTools.md +2856 -0
- package/docs/api/classes/SSEChannel.md +272 -0
- package/docs/{classes → api/classes}/Semaphore.md +26 -26
- package/docs/api/classes/ServerToolTransport.md +323 -0
- package/docs/{classes → api/classes}/ServerTools.md +579 -120
- package/docs/{classes → api/classes}/SignalGate.md +9 -9
- package/docs/api/classes/SseClientPubSubTransport.md +92 -0
- package/docs/api/classes/SseServerPubSubTransport.md +234 -0
- package/docs/{classes → api/classes}/TaskAbortController.md +9 -9
- package/docs/api/classes/ToolFunc.md +2665 -0
- package/docs/api/classes/ToolTransport.md +143 -0
- package/docs/api/classes/YamlTypeBaseObject.md +31 -0
- package/docs/api/enumerations/AsyncFeatureBits.md +33 -0
- package/docs/api/enumerations/AsyncFeatures.md +33 -0
- package/docs/api/enumerations/ErrorCode.md +177 -0
- package/docs/api/enumerations/HashAlgorithm.md +97 -0
- package/docs/{functions → api/functions}/AIArgProcessor.md +1 -1
- package/docs/{functions → api/functions}/AIStream.md +1 -1
- package/docs/{functions → api/functions}/ChoiceArgProcessor.md +1 -1
- package/docs/api/functions/DefaultDateFormat.md +21 -0
- package/docs/{functions → api/functions}/ObjectArgsToArgsInfo.md +1 -1
- package/docs/{functions → api/functions}/RateLimit.md +1 -1
- package/docs/{functions → api/functions}/TemplateArgProcessor.md +1 -1
- package/docs/api/functions/addDate.md +71 -0
- package/docs/{functions → api/functions}/assignDirs.md +1 -1
- package/docs/{functions → api/functions}/backendEventable.md +1 -1
- package/docs/{functions → api/functions}/beforeShutdown.md +1 -1
- package/docs/api/functions/calcPerplexity.md +60 -0
- package/docs/api/functions/calcPerplexitySimple.md +42 -0
- package/docs/api/functions/canonicalize.md +33 -0
- package/docs/{functions → api/functions}/completeSentences.md +1 -1
- package/docs/{functions → api/functions}/concatText.md +1 -1
- package/docs/{functions → api/functions}/countLLMTokens.md +1 -1
- package/docs/{functions → api/functions}/countRegexMatches.md +1 -1
- package/docs/{functions → api/functions}/createAbilityInjector.md +4 -4
- package/docs/{functions → api/functions}/createCallbacksTransformer.md +1 -1
- package/docs/{functions → api/functions}/createEmptyReadableStream.md +1 -1
- package/docs/{functions → api/functions}/createEndWithRepetitionDetector.md +1 -1
- package/docs/{functions → api/functions}/createError.md +1 -1
- package/docs/{functions → api/functions}/createEventStreamTransformer.md +1 -1
- package/docs/{functions → api/functions}/createHfValueFunc.md +1 -1
- package/docs/{functions → api/functions}/createLRUCache.md +1 -1
- package/docs/{functions → api/functions}/createYamlObjectTag.md +1 -1
- package/docs/{functions → api/functions}/dateToText.md +1 -1
- package/docs/{functions → api/functions}/decodeCharset.md +1 -1
- package/docs/api/functions/defaultsWithConcat.md +74 -0
- package/docs/{functions → api/functions}/detectCharset.md +1 -1
- package/docs/{functions → api/functions}/encodeLLMTokens.md +1 -1
- package/docs/{functions → api/functions}/ensureQuoted.md +1 -1
- package/docs/{functions → api/functions}/eventable.md +1 -1
- package/docs/api/functions/expandConfig.md +25 -0
- package/docs/{functions → api/functions}/expandEnv.md +4 -4
- package/docs/{functions → api/functions}/expandObjEnv.md +4 -4
- package/docs/{functions → api/functions}/expandPath.md +1 -1
- package/docs/api/functions/expandPathInObject.md +29 -0
- package/docs/api/functions/expandPaths.md +25 -0
- package/docs/{functions → api/functions}/extNameLevel.md +1 -1
- package/docs/{functions → api/functions}/fileIsExists.md +1 -1
- package/docs/{functions → api/functions}/filterValidFnScope.md +1 -1
- package/docs/{functions → api/functions}/findIndexNonEmptyFrom.md +1 -1
- package/docs/{functions → api/functions}/findPort.md +1 -1
- package/docs/{functions → api/functions}/formatISO.md +1 -1
- package/docs/{functions → api/functions}/formatTextWithSpace.md +1 -1
- package/docs/api/functions/funcGetMeta.md +27 -0
- package/docs/api/functions/funcWithMeta.md +41 -0
- package/docs/api/functions/genUrlParamsStr.md +27 -0
- package/docs/{functions → api/functions}/getAllEnumKeys.md +1 -1
- package/docs/{functions → api/functions}/getConfigFileNames.md +1 -1
- package/docs/{functions → api/functions}/getConfigs.md +1 -1
- package/docs/{functions → api/functions}/getEnvVairables.md +1 -1
- package/docs/{functions → api/functions}/getFileMetaInfo.md +1 -1
- package/docs/{functions → api/functions}/getHashAlgoBySize.md +1 -1
- package/docs/{functions → api/functions}/getKeysPath.md +1 -1
- package/docs/{functions → api/functions}/getLLMTokenizer.md +1 -1
- package/docs/{functions → api/functions}/getMultiLevelExtname.md +4 -4
- package/docs/{functions → api/functions}/getPackageDir.md +1 -1
- package/docs/{functions → api/functions}/getRealFilepath.md +1 -1
- package/docs/{functions → api/functions}/getResponseErrorReadableStream.md +1 -1
- package/docs/{functions → api/functions}/getXDGConfigs.md +1 -1
- package/docs/{functions → api/functions}/hasDirectoryIn.md +1 -1
- package/docs/{functions → api/functions}/hash.md +1 -1
- package/docs/{functions → api/functions}/hashFile.md +1 -1
- package/docs/api/functions/hashObject.md +25 -0
- package/docs/{functions → api/functions}/hashStream.md +1 -1
- package/docs/api/functions/initShutdown.md +15 -0
- package/docs/{functions → api/functions}/isLangUsingSpaces.md +1 -1
- package/docs/{functions → api/functions}/isListItemString.md +1 -1
- package/docs/{functions → api/functions}/isModelNameMatched.md +1 -1
- package/docs/{functions → api/functions}/isPunctuationChar.md +1 -1
- package/docs/{functions → api/functions}/isQuoted.md +1 -1
- package/docs/{functions → api/functions}/isRegExp.md +1 -1
- package/docs/{functions → api/functions}/isSameString.md +1 -1
- package/docs/{functions → api/functions}/isSectionString.md +1 -1
- package/docs/{functions → api/functions}/isSentenceEnding.md +1 -1
- package/docs/{functions → api/functions}/isSepLineString.md +1 -1
- package/docs/{functions → api/functions}/isStrWrapped.md +1 -1
- package/docs/{functions → api/functions}/isSubdirectory.md +2 -2
- package/docs/{functions → api/functions}/isTitleString.md +1 -1
- package/docs/{functions → api/functions}/isValidFilename.md +1 -1
- package/docs/{functions → api/functions}/isValidFilepath.md +1 -1
- package/docs/{functions → api/functions}/isWebStream.md +1 -1
- package/docs/api/functions/joinSplitWords.md +46 -0
- package/docs/{functions → api/functions}/jsonFilterToWhere.md +1 -1
- package/docs/{functions → api/functions}/jsonToMarkdownStr.md +9 -1
- package/docs/{functions → api/functions}/loadAIConfig.md +1 -1
- package/docs/{functions → api/functions}/loadConfig.md +1 -1
- package/docs/{functions → api/functions}/loadConfigFile.md +1 -1
- package/docs/{functions → api/functions}/loadFileFromPaths.md +1 -1
- package/docs/{functions → api/functions}/loadTextFromPaths.md +1 -1
- package/docs/{functions → api/functions}/lrucache.md +1 -1
- package/docs/{functions → api/functions}/makeToolFuncCancelable.md +1 -1
- package/docs/{functions → api/functions}/matchUrlProtocol.md +1 -1
- package/docs/{functions → api/functions}/memoize.md +1 -1
- package/docs/api/functions/mergeArray.md +57 -0
- package/docs/{functions → api/functions}/messagesToText.md +1 -1
- package/docs/api/functions/normalizePath.md +21 -0
- package/docs/{functions → api/functions}/paramsSizeToScaleStr.md +1 -1
- package/docs/{functions → api/functions}/parseCommand.md +1 -1
- package/docs/{functions → api/functions}/parseDateFormat.md +1 -1
- package/docs/{functions → api/functions}/parseISO.md +1 -1
- package/docs/{functions → api/functions}/parseJsJson.md +1 -1
- package/docs/{functions → api/functions}/parseJsJsonSimpleSync.md +1 -1
- package/docs/{functions → api/functions}/parseObjectArgInfo.md +1 -1
- package/docs/{functions → api/functions}/parseObjectArgumentInfos.md +1 -1
- package/docs/{functions → api/functions}/parseObjectArguments.md +1 -1
- package/docs/{functions → api/functions}/parseObjectArgumentsAsArgInfos.md +1 -1
- package/docs/api/functions/parseYaml.md +45 -0
- package/docs/api/functions/pruneSubdirectories.md +35 -0
- package/docs/api/functions/pruneSubdirectoriesInPlace.md +38 -0
- package/docs/{functions → api/functions}/quoteStr.md +1 -1
- package/docs/{functions → api/functions}/readFilenamesRecursiveSync.md +7 -1
- package/docs/{functions → api/functions}/readTextFileChunks.md +1 -1
- package/docs/{functions → api/functions}/readTextFileChunksEx.md +1 -1
- package/docs/{functions → api/functions}/readableFromAsyncIterable.md +1 -1
- package/docs/{functions → api/functions}/registerCoreTools.md +1 -1
- package/docs/api/functions/registerYamlTag.md +37 -0
- package/docs/{functions → api/functions}/removeMarkdownBold.md +1 -1
- package/docs/{functions → api/functions}/removeMarkdownBoldAndItalic.md +1 -1
- package/docs/{functions → api/functions}/removeMarkdownItalic.md +1 -1
- package/docs/{functions → api/functions}/replaceWithPlaceholder.md +1 -1
- package/docs/{functions → api/functions}/restoreFromPlacehoders.md +1 -1
- package/docs/{functions → api/functions}/sanitizeFilename.md +4 -4
- package/docs/{functions → api/functions}/sanitizeFilepath.md +4 -4
- package/docs/{functions → api/functions}/saveConfigFile.md +1 -1
- package/docs/{functions → api/functions}/scaleStrToParamsSize.md +1 -1
- package/docs/{functions → api/functions}/shutdown.md +1 -1
- package/docs/{functions → api/functions}/simplifyObjectArguments.md +1 -1
- package/docs/api/functions/sleep.md +36 -0
- package/docs/{functions → api/functions}/sortedValues.md +1 -1
- package/docs/{functions → api/functions}/splitChunks.md +1 -1
- package/docs/{functions → api/functions}/splitParagraph.md +1 -1
- package/docs/{functions → api/functions}/splitSentence.md +1 -1
- package/docs/api/functions/splitWords.md +42 -0
- package/docs/api/functions/stringifyYaml.md +45 -0
- package/docs/{functions → api/functions}/stripConsoleColor.md +1 -1
- package/docs/{functions → api/functions}/textToDate.md +1 -1
- package/docs/{functions → api/functions}/throwError.md +3 -3
- package/docs/{functions → api/functions}/toDate.md +1 -1
- package/docs/{functions → api/functions}/toDateTime.md +1 -1
- package/docs/{functions → api/functions}/toRegExp.md +1 -1
- package/docs/{functions → api/functions}/trimStartOfStreamHelper.md +1 -1
- package/docs/{functions → api/functions}/truncTo.md +1 -1
- package/docs/{functions → api/functions}/truncateByToken.md +1 -1
- package/docs/{functions → api/functions}/truncateToTokenLimit.md +1 -1
- package/docs/{functions → api/functions}/truncateToTokenLimitEx.md +1 -1
- package/docs/{functions → api/functions}/uuid.md +1 -1
- package/docs/{functions → api/functions}/uuidParse.md +1 -1
- package/docs/{functions → api/functions}/uuidStringify.md +1 -1
- package/docs/{functions → api/functions}/uuidValidate.md +1 -1
- package/docs/{functions → api/functions}/uuidVersion.md +1 -1
- package/docs/{functions → api/functions}/uuidv1.md +9 -5
- package/docs/{functions → api/functions}/uuidv4.md +9 -5
- package/docs/{functions → api/functions}/uuidv5.md +9 -5
- package/docs/api/functions/wait.md +45 -0
- package/docs/{functions → api/functions}/wrapEventEmitter.md +1 -1
- package/docs/{functions → api/functions}/xxhash.md +1 -1
- package/docs/{functions → api/functions}/xxhash32.md +1 -1
- package/docs/{functions → api/functions}/xxhash64.md +1 -1
- package/docs/{functions → api/functions}/xxhashAsStr.md +1 -1
- package/docs/api/functions/yieldExec.md +27 -0
- package/docs/{globals.md → api/globals.md} +44 -24
- package/docs/api/interfaces/AIChatAssistantMessageParam.md +129 -0
- package/docs/api/interfaces/AIChatContentPartImage.md +29 -0
- package/docs/api/interfaces/AIChatContentPartText.md +25 -0
- package/docs/api/interfaces/AIChatMessageParamBase.md +68 -0
- package/docs/api/interfaces/AIChatMessageToolCall.md +41 -0
- package/docs/{interfaces → api/interfaces}/AIChatSystemMessageParam.md +9 -9
- package/docs/api/interfaces/AIChatToolChoiceFuncObject.md +37 -0
- package/docs/api/interfaces/AIChatToolChoiceObject.md +25 -0
- package/docs/api/interfaces/AIChatToolFunc.md +41 -0
- package/docs/api/interfaces/AIChatToolFuncParam.md +37 -0
- package/docs/api/interfaces/AIChatToolMessageParam.md +113 -0
- package/docs/api/interfaces/AIChatToolParam.md +25 -0
- package/docs/api/interfaces/AIChatToolTypeObject.md +17 -0
- package/docs/api/interfaces/AIChatUserMessageParam.md +137 -0
- package/docs/api/interfaces/AIChoiceConfig.md +65 -0
- package/docs/api/interfaces/AIResult.md +65 -0
- package/docs/{interfaces → api/interfaces}/AIStreamParser.md +2 -2
- package/docs/api/interfaces/AIStreamParserOptions.md +21 -0
- package/docs/api/interfaces/BaseFunc.md +299 -0
- package/docs/api/interfaces/BaseFuncItem.md +221 -0
- package/docs/api/interfaces/BinarySemaphoreAcquireOptions.md +25 -0
- package/docs/api/interfaces/BinarySemaphoreOptions.md +57 -0
- package/docs/api/interfaces/BinarySemaphoreReleaseOptions.md +25 -0
- package/docs/api/interfaces/BinarySemaphoreReleaserFunc.md +37 -0
- package/docs/api/interfaces/CancelableAbilityOptions.md +113 -0
- package/docs/api/interfaces/ClientFuncItem.md +326 -0
- package/docs/api/interfaces/EventClientFuncParams.md +51 -0
- package/docs/api/interfaces/EventServerFuncParams.md +73 -0
- package/docs/api/interfaces/FewShotPromptTemplateOptions.md +159 -0
- package/docs/api/interfaces/FuncItem.md +281 -0
- package/docs/api/interfaces/FuncParam.md +51 -0
- package/docs/api/interfaces/FuncParams.md +28 -0
- package/docs/api/interfaces/Funcs.md +15 -0
- package/docs/api/interfaces/HashAlgoParams.md +33 -0
- package/docs/api/interfaces/IClientToolTransport.md +155 -0
- package/docs/api/interfaces/IFileMetaInfo.md +65 -0
- package/docs/api/interfaces/IPubSubClientTransport.md +70 -0
- package/docs/api/interfaces/IPubSubServerTransport.md +241 -0
- package/docs/{interfaces → api/interfaces}/IReadTextFileChunksOptions.md +12 -12
- package/docs/api/interfaces/IServerToolTransport.md +159 -0
- package/docs/api/interfaces/IToolTransport.md +73 -0
- package/docs/api/interfaces/ITruncateToTokenLimitOptions.md +99 -0
- package/docs/api/interfaces/JsonFilter.md +13 -0
- package/docs/api/interfaces/ParseObjectArgumentOptions.md +89 -0
- package/docs/api/interfaces/ProbabilityItem.md +41 -0
- package/docs/api/interfaces/PromptExampleSelectorOptions.md +34 -0
- package/docs/api/interfaces/PromptTemplateOptions.md +73 -0
- package/docs/api/interfaces/PubSubClient.md +27 -0
- package/docs/api/interfaces/PubSubClientStream.md +196 -0
- package/docs/api/interfaces/PubSubServerSession.md +103 -0
- package/docs/api/interfaces/RemoteFuncItem.md +316 -0
- package/docs/api/interfaces/ReplacePlacehoderOptions.md +41 -0
- package/docs/api/interfaces/ResClientFuncParams.md +37 -0
- package/docs/api/interfaces/ResServerFuncParams.md +73 -0
- package/docs/api/interfaces/SanitizeFilenameOptions.md +25 -0
- package/docs/api/interfaces/SectionStringOptions.md +25 -0
- package/docs/api/interfaces/SemaphoreOptions.md +89 -0
- package/docs/api/interfaces/SemaphoreTaskItem.md +73 -0
- package/docs/api/interfaces/ServerFuncItem.md +339 -0
- package/docs/api/interfaces/ServerFuncParams.md +41 -0
- package/docs/api/interfaces/SplitSentenceOptions.md +41 -0
- package/docs/{interfaces → api/interfaces}/StreamCallbacksAndOptions.md +5 -5
- package/docs/{interfaces → api/interfaces}/TaskAbortControllers.md +1 -1
- package/docs/{interfaces → api/interfaces}/TaskPromise.md +6 -6
- package/docs/api/interfaces/ToolFuncPackage.md +57 -0
- package/docs/{namespaces → api/namespaces}/EventStates/variables/ABORT.md +1 -1
- package/docs/{namespaces → api/namespaces}/EventStates/variables/CONTINUE.md +1 -1
- package/docs/{namespaces → api/namespaces}/EventStates/variables/DONE.md +1 -1
- package/docs/{namespaces → api/namespaces}/EventStates/variables/STOPPED.md +1 -1
- package/docs/{namespaces → api/namespaces}/uuidv5/variables/DNS.md +1 -1
- package/docs/{namespaces → api/namespaces}/uuidv5/variables/URL.md +1 -1
- package/docs/{type-aliases → api/type-aliases}/AIChatContentPart.md +1 -1
- package/docs/{type-aliases → api/type-aliases}/AIChatMessageParam.md +1 -1
- package/docs/{type-aliases → api/type-aliases}/AIChatRole.md +1 -1
- package/docs/{type-aliases → api/type-aliases}/AIChatToolChoiceParam.md +1 -1
- package/docs/{type-aliases → api/type-aliases}/AIMessageType.md +1 -1
- package/docs/api/type-aliases/AIModelNameRule.md +14 -0
- package/docs/api/type-aliases/AIModelNameRuleFn.md +28 -0
- package/docs/api/type-aliases/AIModelNameRules.md +13 -0
- package/docs/{type-aliases → api/type-aliases}/AITextGenerationFinishReason.md +1 -1
- package/docs/api/type-aliases/ActionName.md +13 -0
- package/docs/api/type-aliases/ArrayMergeWay.md +11 -0
- package/docs/api/type-aliases/AsyncTaskId.md +11 -0
- package/docs/{type-aliases → api/type-aliases}/BeforeShutdownListener.md +1 -1
- package/docs/{type-aliases → api/type-aliases}/EventErrorListenerFn.md +1 -1
- package/docs/{type-aliases → api/type-aliases}/EventListenerFn.md +1 -1
- package/docs/api/type-aliases/FuncParamType.md +13 -0
- package/docs/{type-aliases → api/type-aliases}/PromptExamples.md +1 -1
- package/docs/api/type-aliases/PubSubClientId.md +14 -0
- package/docs/api/type-aliases/PubSubCtx.md +37 -0
- package/docs/api/type-aliases/RpcMethodHandler.md +34 -0
- package/docs/{type-aliases → api/type-aliases}/SemaphoreIsReadyFuncType.md +1 -1
- package/docs/api/type-aliases/TFunc.md +33 -0
- package/docs/{variables → api/variables}/AIChatRoles.md +1 -1
- package/docs/{variables → api/variables}/AIMessageTypes.md +1 -1
- package/docs/{variables → api/variables}/AITextGenerationFinishReasons.md +1 -1
- package/docs/{variables → api/variables}/AbortErrorCode.md +1 -1
- package/docs/api/variables/ActionNames.md +13 -0
- package/docs/{variables → api/variables}/AlreadyExistsErrorCode.md +1 -1
- package/docs/api/variables/ArrayMergeWay.md +25 -0
- package/docs/api/variables/ArrayMergeWaySymbol.md +11 -0
- package/docs/api/variables/ClientToolFuncSchema.md +83 -0
- package/docs/{variables → api/variables}/DEFAULT_CONFIG_NAME.md +1 -1
- package/docs/{variables → api/variables}/DefaultAsyncSemaphoreCapacity.md +1 -1
- package/docs/api/variables/EventBusName.md +11 -0
- package/docs/api/variables/EventName.md +11 -0
- package/docs/{variables → api/variables}/FilenameReservedRegex.md +1 -1
- package/docs/api/variables/FuncMetaSymbol.md +15 -0
- package/docs/{variables → api/variables}/InternalErrorCode.md +1 -1
- package/docs/{variables → api/variables}/LLM_TOKENIZER_NAMES.md +1 -1
- package/docs/{variables → api/variables}/LLM_TOKENIZER_NAMES_MAP.md +1 -1
- package/docs/{variables → api/variables}/NotFoundErrorCode.md +1 -1
- package/docs/{variables → api/variables}/NotImplementedErrorCode.md +1 -1
- package/docs/api/variables/PASSING_SCORE.md +13 -0
- package/docs/api/variables/RStreamErrCode.md +11 -0
- package/docs/api/variables/RemoteToolFuncSchema.md +84 -0
- package/docs/api/variables/ResponseRStreamErrCode.md +11 -0
- package/docs/{variables → api/variables}/SHUTDOWN_SIGNALS.md +1 -1
- package/docs/{variables → api/variables}/SSEChannelAlreadyClosedErrCode.md +1 -1
- package/docs/api/variables/SecondaryCache.md +11 -0
- package/docs/api/variables/ServerToolFuncSchema.md +83 -0
- package/docs/api/variables/StrangeHumanName.md +11 -0
- package/docs/api/variables/ToolAsyncCancelableBit.md +11 -0
- package/docs/api/variables/ToolAsyncMultiTaskBit.md +11 -0
- package/docs/api/variables/ToolAsyncPriorityBit.md +11 -0
- package/docs/{variables → api/variables}/ToolFuncSchema.md +14 -1
- package/docs/{variables → api/variables}/WindowsReservedNameRegex.md +1 -1
- package/docs/api/variables/base32768.md +11 -0
- package/docs/api/variables/defaultTemplateFormat.md +11 -0
- package/docs/api/variables/event.md +11 -0
- package/docs/api/variables/eventClient.md +11 -0
- package/docs/api/variables/eventServer.md +11 -0
- package/docs/api/variables/lrucache.md +11 -0
- package/docs/{variables → api/variables}/mimeType.md +1 -1
- package/docs/{variables → api/variables}/uuidNIL.md +1 -1
- package/docs/pubsub.md +326 -0
- package/docs/server_client_tools.md +88 -0
- package/docs/toolFunc.md +183 -0
- package/docs/transport.md +137 -0
- package/package.json +38 -38
- package/dist/chunk-YVFGQB4L.mjs +0 -1
- package/dist/index-BkwhCK1q.d.mts +0 -899
- package/dist/index-BkwhCK1q.d.ts +0 -899
- package/docs/README.md +0 -250
- package/docs/classes/AlreadyExistsError.md +0 -346
- package/docs/classes/BaseError.md +0 -359
- package/docs/classes/ConfigFile.md +0 -353
- package/docs/classes/HFEnvironment.md +0 -184
- package/docs/classes/HFInterpreter.md +0 -77
- package/docs/classes/HFTemplate.md +0 -67
- package/docs/classes/HfPromptTemplate.md +0 -1158
- package/docs/classes/NotFoundError.md +0 -346
- package/docs/classes/NotImplementationError.md +0 -346
- package/docs/classes/ReadableStreamError.md +0 -366
- package/docs/classes/ResClientTools.md +0 -2451
- package/docs/classes/ResServerTools.md +0 -2427
- package/docs/classes/SSEChannel.md +0 -270
- package/docs/classes/ToolFunc.md +0 -2201
- package/docs/classes/YamlTypeBaseObject.md +0 -31
- package/docs/enumerations/AsyncFeatureBits.md +0 -33
- package/docs/enumerations/AsyncFeatures.md +0 -33
- package/docs/enumerations/ErrorCode.md +0 -177
- package/docs/enumerations/HashAlgorithm.md +0 -97
- package/docs/functions/canonicalize.md +0 -21
- package/docs/functions/expandConfig.md +0 -25
- package/docs/functions/filenameReservedRegex.md +0 -20
- package/docs/functions/hfParse.md +0 -24
- package/docs/functions/hfTokenize.md +0 -27
- package/docs/functions/initShutdown.md +0 -15
- package/docs/functions/interpolateEnv.md +0 -29
- package/docs/functions/interpolateFString.md +0 -29
- package/docs/functions/interpolateGolangTemplate.md +0 -35
- package/docs/functions/parseFString.md +0 -26
- package/docs/functions/parseYaml.md +0 -25
- package/docs/functions/reControlCharsRegex.md +0 -19
- package/docs/functions/registerYamlTag.md +0 -21
- package/docs/functions/stringifyYaml.md +0 -25
- package/docs/functions/wait.md +0 -21
- package/docs/interfaces/AIChatAssistantMessageParam.md +0 -129
- package/docs/interfaces/AIChatContentPartImage.md +0 -29
- package/docs/interfaces/AIChatContentPartText.md +0 -25
- package/docs/interfaces/AIChatMessageParamBase.md +0 -68
- package/docs/interfaces/AIChatMessageToolCall.md +0 -41
- package/docs/interfaces/AIChatToolChoiceFuncObject.md +0 -37
- package/docs/interfaces/AIChatToolChoiceObject.md +0 -25
- package/docs/interfaces/AIChatToolFunc.md +0 -41
- package/docs/interfaces/AIChatToolFuncParam.md +0 -37
- package/docs/interfaces/AIChatToolMessageParam.md +0 -113
- package/docs/interfaces/AIChatToolParam.md +0 -25
- package/docs/interfaces/AIChatToolTypeObject.md +0 -17
- package/docs/interfaces/AIChatUserMessageParam.md +0 -137
- package/docs/interfaces/AIChoiceConfig.md +0 -65
- package/docs/interfaces/AIResult.md +0 -65
- package/docs/interfaces/AIStreamParserOptions.md +0 -21
- package/docs/interfaces/BaseFunc.md +0 -157
- package/docs/interfaces/BaseFuncItem.md +0 -101
- package/docs/interfaces/BinarySemaphoreAcquireOptions.md +0 -25
- package/docs/interfaces/BinarySemaphoreOptions.md +0 -57
- package/docs/interfaces/BinarySemaphoreReleaseOptions.md +0 -25
- package/docs/interfaces/BinarySemaphoreReleaserFunc.md +0 -37
- package/docs/interfaces/CancelableAbilityOptions.md +0 -113
- package/docs/interfaces/ClientFuncItem.md +0 -175
- package/docs/interfaces/DotenvExpandOptions.md +0 -43
- package/docs/interfaces/DotenvExpandOutput.md +0 -25
- package/docs/interfaces/DotenvParseInput.md +0 -13
- package/docs/interfaces/DotenvParseOutput.md +0 -13
- package/docs/interfaces/DotenvPopulateInput.md +0 -13
- package/docs/interfaces/EventClientFuncParams.md +0 -51
- package/docs/interfaces/EventServerFuncParams.md +0 -67
- package/docs/interfaces/FewShotPromptTemplateOptions.md +0 -147
- package/docs/interfaces/FuncItem.md +0 -143
- package/docs/interfaces/FuncParam.md +0 -61
- package/docs/interfaces/FuncParams.md +0 -13
- package/docs/interfaces/Funcs.md +0 -13
- package/docs/interfaces/HashAlgoParams.md +0 -33
- package/docs/interfaces/IFileMetaInfo.md +0 -65
- package/docs/interfaces/ITruncateToTokenLimitOptions.md +0 -99
- package/docs/interfaces/JsonFilter.md +0 -13
- package/docs/interfaces/ParseObjectArgumentOptions.md +0 -89
- package/docs/interfaces/PromptExampleSelectorOptions.md +0 -34
- package/docs/interfaces/PromptTemplateOptions.md +0 -65
- package/docs/interfaces/RemoteFuncItem.md +0 -164
- package/docs/interfaces/ReplacePlacehoderOptions.md +0 -41
- package/docs/interfaces/ResClientFuncParams.md +0 -37
- package/docs/interfaces/ResServerFuncParams.md +0 -69
- package/docs/interfaces/SanitizeFilenameOptions.md +0 -25
- package/docs/interfaces/SectionStringOptions.md +0 -25
- package/docs/interfaces/SemaphoreOptions.md +0 -89
- package/docs/interfaces/SemaphoreTaskItem.md +0 -73
- package/docs/interfaces/ServerFuncItem.md +0 -183
- package/docs/interfaces/ServerFuncParams.md +0 -35
- package/docs/interfaces/SplitSentenceOptions.md +0 -41
- package/docs/interfaces/ToolFuncPackage.md +0 -47
- package/docs/type-aliases/AIModelNameRule.md +0 -11
- package/docs/type-aliases/AIModelNameRuleFn.md +0 -21
- package/docs/type-aliases/AIModelNameRules.md +0 -11
- package/docs/type-aliases/ActionName.md +0 -11
- package/docs/type-aliases/AsyncTaskId.md +0 -11
- package/docs/type-aliases/FStringPromptTemplateNode.md +0 -14
- package/docs/type-aliases/FuncParamType.md +0 -11
- package/docs/type-aliases/PromptTemplateType.md +0 -11
- package/docs/type-aliases/PromptType.md +0 -11
- package/docs/type-aliases/TFunc.md +0 -25
- package/docs/variables/ActionNames.md +0 -11
- package/docs/variables/ClientToolFuncSchema.md +0 -101
- package/docs/variables/EventBusName.md +0 -11
- package/docs/variables/EventName.md +0 -11
- package/docs/variables/HFBuiltins.md +0 -122
- package/docs/variables/PASSING_SCORE.md +0 -11
- package/docs/variables/PromptTemplateTypes.md +0 -11
- package/docs/variables/PromptTypes.md +0 -14
- package/docs/variables/RStreamErrCode.md +0 -11
- package/docs/variables/RemoteToolFuncSchema.md +0 -101
- package/docs/variables/ResponseRStreamErrCode.md +0 -11
- package/docs/variables/SecondaryCache.md +0 -11
- package/docs/variables/ServerToolFuncSchema.md +0 -101
- package/docs/variables/ToolAsyncCancelableBit.md +0 -11
- package/docs/variables/ToolAsyncMultiTaskBit.md +0 -11
- package/docs/variables/ToolAsyncPriorityBit.md +0 -11
- package/docs/variables/base32768.md +0 -11
- package/docs/variables/defaultTemplateFormat.md +0 -11
- package/docs/variables/event.md +0 -11
- package/docs/variables/eventClient.md +0 -11
- package/docs/variables/eventServer.md +0 -11
- package/docs/variables/lrucache.md +0 -11
- /package/docs/{_media → api/_media}/LICENSE-MIT +0 -0
- /package/docs/{namespaces → api/namespaces}/EventStates/README.md +0 -0
- /package/docs/{namespaces → api/namespaces}/uuidv5/README.md +0 -0
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: EventServer
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/ai-tool/src/funcs/event-server.ts:
|
|
9
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-server.ts:20](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/funcs/event-server.ts#L20)
|
|
10
10
|
|
|
11
11
|
## Extends
|
|
12
12
|
|
|
@@ -22,7 +22,7 @@ Defined in: [packages/ai-tool/src/funcs/event-server.ts:18](https://github.com/i
|
|
|
22
22
|
|
|
23
23
|
> **new EventServer**(`name`, `options`): [`EventServer`](EventServer.md)
|
|
24
24
|
|
|
25
|
-
Defined in: [packages/ai-tool/src/res-server-tools.ts:27](https://github.com/isdk/ai-tool.js/blob/
|
|
25
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-server-tools.ts:27](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/res-server-tools.ts#L27)
|
|
26
26
|
|
|
27
27
|
The initial value of Object.prototype.constructor is the standard built-in Object constructor.
|
|
28
28
|
|
|
@@ -50,7 +50,7 @@ The initial value of Object.prototype.constructor is the standard built-in Objec
|
|
|
50
50
|
|
|
51
51
|
> **$attributes**: `Properties`
|
|
52
52
|
|
|
53
|
-
Defined in:
|
|
53
|
+
Defined in: [property-manager.js/src/advance.d.ts:5](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/advance.d.ts#L5)
|
|
54
54
|
|
|
55
55
|
#### Inherited from
|
|
56
56
|
|
|
@@ -62,7 +62,10 @@ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-ma
|
|
|
62
62
|
|
|
63
63
|
> **action**: `"get"` \| `"post"` \| `"put"` \| `"delete"` \| `"patch"` \| `"list"` \| `"res"` = `'res'`
|
|
64
64
|
|
|
65
|
-
Defined in: [packages/ai-tool/src/res-server-tools.ts:21](https://github.com/isdk/ai-tool.js/blob/
|
|
65
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-server-tools.ts:21](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/res-server-tools.ts#L21)
|
|
66
|
+
|
|
67
|
+
The action to be used for the remote call. This typically represents an RPC method name.
|
|
68
|
+
Only for RESTful HTTP transports, it might be mapped to a standard HTTP method (e.g., GET, POST)
|
|
66
69
|
|
|
67
70
|
#### Inherited from
|
|
68
71
|
|
|
@@ -74,7 +77,9 @@ Defined in: [packages/ai-tool/src/res-server-tools.ts:21](https://github.com/isd
|
|
|
74
77
|
|
|
75
78
|
> `optional` **alias**: `string` \| `string`[]
|
|
76
79
|
|
|
77
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
80
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:130](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L130)
|
|
81
|
+
|
|
82
|
+
Optional aliases for the function name.
|
|
78
83
|
|
|
79
84
|
#### Inherited from
|
|
80
85
|
|
|
@@ -86,7 +91,11 @@ Defined in: [packages/ai-tool/src/tool-func.ts:31](https://github.com/isdk/ai-to
|
|
|
86
91
|
|
|
87
92
|
> `optional` **allowExportFunc**: `boolean`
|
|
88
93
|
|
|
89
|
-
Defined in: [packages/ai-tool/src/server-tools.ts:
|
|
94
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:35](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/server-tools.ts#L35)
|
|
95
|
+
|
|
96
|
+
If set to true, the body of the function (`func`) will be serialized and sent
|
|
97
|
+
to the client when tools are loaded. This allows the client to execute the
|
|
98
|
+
function locally instead of making a remote call. Defaults to false.
|
|
90
99
|
|
|
91
100
|
#### Inherited from
|
|
92
101
|
|
|
@@ -94,11 +103,17 @@ Defined in: [packages/ai-tool/src/server-tools.ts:14](https://github.com/isdk/ai
|
|
|
94
103
|
|
|
95
104
|
***
|
|
96
105
|
|
|
97
|
-
### apiRoot
|
|
106
|
+
### ~~apiRoot?~~
|
|
98
107
|
|
|
99
108
|
> `optional` **apiRoot**: `string`
|
|
100
109
|
|
|
101
|
-
Defined in: [packages/ai-tool/src/utils/consts.ts:
|
|
110
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:89](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/consts.ts#L89)
|
|
111
|
+
|
|
112
|
+
The root endpoint for the remote service.
|
|
113
|
+
|
|
114
|
+
#### Deprecated
|
|
115
|
+
|
|
116
|
+
Use `transport` instead.
|
|
102
117
|
|
|
103
118
|
#### Inherited from
|
|
104
119
|
|
|
@@ -106,11 +121,41 @@ Defined in: [packages/ai-tool/src/utils/consts.ts:34](https://github.com/isdk/ai
|
|
|
106
121
|
|
|
107
122
|
***
|
|
108
123
|
|
|
124
|
+
### asyncFeatures?
|
|
125
|
+
|
|
126
|
+
> `optional` **asyncFeatures**: `number`
|
|
127
|
+
|
|
128
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:144](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L144)
|
|
129
|
+
|
|
130
|
+
A bitmask representing asynchronous features supported by the function, built from `AsyncFeatureBits`.
|
|
131
|
+
This allows the system to understand if a function supports capabilities like cancellation or multi-tasking.
|
|
132
|
+
|
|
133
|
+
#### See
|
|
134
|
+
|
|
135
|
+
AsyncFeatureBits from `@src/utils/cancelable-ability.ts`
|
|
136
|
+
|
|
137
|
+
#### Example
|
|
138
|
+
|
|
139
|
+
```ts
|
|
140
|
+
import { AsyncFeatures } from './utils';
|
|
141
|
+
const func = new ToolFunc({
|
|
142
|
+
name: 'cancellableTask',
|
|
143
|
+
asyncFeatures: AsyncFeatures.Cancelable | AsyncFeatures.MultiTask,
|
|
144
|
+
// ...
|
|
145
|
+
});
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
#### Inherited from
|
|
149
|
+
|
|
150
|
+
[`ResServerTools`](ResServerTools.md).[`asyncFeatures`](ResServerTools.md#asyncfeatures)
|
|
151
|
+
|
|
152
|
+
***
|
|
153
|
+
|
|
109
154
|
### constructor
|
|
110
155
|
|
|
111
156
|
> **constructor**: `Function`
|
|
112
157
|
|
|
113
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:125
|
|
158
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:125
|
|
114
159
|
|
|
115
160
|
The initial value of Object.prototype.constructor is the standard built-in Object constructor.
|
|
116
161
|
|
|
@@ -124,7 +169,7 @@ The initial value of Object.prototype.constructor is the standard built-in Objec
|
|
|
124
169
|
|
|
125
170
|
> **defaultOptions**: `object`
|
|
126
171
|
|
|
127
|
-
Defined in:
|
|
172
|
+
Defined in: [property-manager.js/src/abstract.d.ts:74](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L74)
|
|
128
173
|
|
|
129
174
|
The default options for export and assign
|
|
130
175
|
|
|
@@ -146,27 +191,66 @@ The default options for export and assign
|
|
|
146
191
|
|
|
147
192
|
> **depends**: `object`
|
|
148
193
|
|
|
149
|
-
Defined in: [packages/ai-tool/src/funcs/event-server.ts:
|
|
194
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-server.ts:37](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/funcs/event-server.ts#L37)
|
|
195
|
+
|
|
196
|
+
A map of dependencies this function has on other tool functions.
|
|
197
|
+
Declaring dependencies ensures that they are automatically registered when this function is registered.
|
|
198
|
+
This is crucial for building modular functions that rely on each other without needing to manage registration order manually.
|
|
150
199
|
|
|
151
200
|
#### event-bus
|
|
152
201
|
|
|
153
202
|
> **event-bus**: [`EventToolFunc`](EventToolFunc.md) = `event`
|
|
154
203
|
|
|
204
|
+
#### Example
|
|
205
|
+
|
|
206
|
+
```ts
|
|
207
|
+
const helperFunc = new ToolFunc({ name: 'helper', func: () => 'world' });
|
|
208
|
+
const mainFunc = new ToolFunc({
|
|
209
|
+
name: 'main',
|
|
210
|
+
depends: {
|
|
211
|
+
helper: helperFunc,
|
|
212
|
+
},
|
|
213
|
+
func() {
|
|
214
|
+
// We can now safely run the dependency
|
|
215
|
+
const result = this.runSync('helper');
|
|
216
|
+
return `Hello, ${result}`;
|
|
217
|
+
}
|
|
218
|
+
});
|
|
219
|
+
// When mainFunc is registered, helperFunc will be registered automatically.
|
|
220
|
+
mainFunc.register();
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
#### Overrides
|
|
224
|
+
|
|
225
|
+
[`ResServerTools`](ResServerTools.md).[`depends`](ResServerTools.md#depends)
|
|
226
|
+
|
|
155
227
|
***
|
|
156
228
|
|
|
157
229
|
### description
|
|
158
230
|
|
|
159
|
-
> **description**: `string` = `'subscribe server
|
|
231
|
+
> **description**: `string` = `'subscribe server event'`
|
|
232
|
+
|
|
233
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-server.ts:35](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/funcs/event-server.ts#L35)
|
|
234
|
+
|
|
235
|
+
A detailed description of what the function does.
|
|
236
|
+
|
|
237
|
+
#### Overrides
|
|
160
238
|
|
|
161
|
-
|
|
239
|
+
[`ResServerTools`](ResServerTools.md).[`description`](ResServerTools.md#description)
|
|
162
240
|
|
|
163
241
|
***
|
|
164
242
|
|
|
165
|
-
### fetchOptions
|
|
243
|
+
### ~~fetchOptions?~~
|
|
166
244
|
|
|
167
245
|
> `optional` **fetchOptions**: `any`
|
|
168
246
|
|
|
169
|
-
Defined in: [packages/ai-tool/src/utils/consts.ts:
|
|
247
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:101](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/consts.ts#L101)
|
|
248
|
+
|
|
249
|
+
Options to be passed to the underlying `fetch` call in an HTTP transport.
|
|
250
|
+
|
|
251
|
+
#### Deprecated
|
|
252
|
+
|
|
253
|
+
Use `transport` instead.
|
|
170
254
|
|
|
171
255
|
#### Inherited from
|
|
172
256
|
|
|
@@ -178,7 +262,9 @@ Defined in: [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai
|
|
|
178
262
|
|
|
179
263
|
> `optional` **isApi**: `boolean`
|
|
180
264
|
|
|
181
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
265
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:119](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L119)
|
|
266
|
+
|
|
267
|
+
If true, indicates that this function should be treated as a server-side API.
|
|
182
268
|
|
|
183
269
|
#### Inherited from
|
|
184
270
|
|
|
@@ -190,7 +276,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-to
|
|
|
190
276
|
|
|
191
277
|
> **methods**: `string`[]
|
|
192
278
|
|
|
193
|
-
Defined in: [packages/ai-tool/src/rpc-methods-server-tool.ts:11](https://github.com/isdk/ai-tool.js/blob/
|
|
279
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-server-tool.ts:11](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/rpc-methods-server-tool.ts#L11)
|
|
194
280
|
|
|
195
281
|
#### Inherited from
|
|
196
282
|
|
|
@@ -198,15 +284,17 @@ Defined in: [packages/ai-tool/src/rpc-methods-server-tool.ts:11](https://github.
|
|
|
198
284
|
|
|
199
285
|
***
|
|
200
286
|
|
|
201
|
-
### name
|
|
287
|
+
### name?
|
|
202
288
|
|
|
203
|
-
> **name**: `string`
|
|
289
|
+
> `optional` **name**: `string`
|
|
204
290
|
|
|
205
|
-
Defined in: [packages/ai-tool/src/
|
|
291
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:76](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L76)
|
|
206
292
|
|
|
207
|
-
|
|
293
|
+
The unique name of the function.
|
|
294
|
+
|
|
295
|
+
#### Inherited from
|
|
208
296
|
|
|
209
|
-
[`ResServerTools`](ResServerTools.md).[`name`](ResServerTools.md#name-
|
|
297
|
+
[`ResServerTools`](ResServerTools.md).[`name`](ResServerTools.md#name-3)
|
|
210
298
|
|
|
211
299
|
***
|
|
212
300
|
|
|
@@ -214,7 +302,7 @@ Defined in: [packages/ai-tool/src/funcs/event-server.ts:27](https://github.com/i
|
|
|
214
302
|
|
|
215
303
|
> **nonExported1stChar**: `string`
|
|
216
304
|
|
|
217
|
-
Defined in:
|
|
305
|
+
Defined in: [property-manager.js/src/abstract.d.ts:78](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L78)
|
|
218
306
|
|
|
219
307
|
the property with the default prefix '$' will not be exported.
|
|
220
308
|
|
|
@@ -228,7 +316,7 @@ the property with the default prefix '$' will not be exported.
|
|
|
228
316
|
|
|
229
317
|
> **params**: [`FuncParams`](../interfaces/FuncParams.md)
|
|
230
318
|
|
|
231
|
-
Defined in: [packages/ai-tool/src/res-server-tools.ts:22](https://github.com/isdk/ai-tool.js/blob/
|
|
319
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-server-tools.ts:22](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/res-server-tools.ts#L22)
|
|
232
320
|
|
|
233
321
|
#### Inherited from
|
|
234
322
|
|
|
@@ -240,7 +328,9 @@ Defined in: [packages/ai-tool/src/res-server-tools.ts:22](https://github.com/isd
|
|
|
240
328
|
|
|
241
329
|
> **result**: `string` = `'event'`
|
|
242
330
|
|
|
243
|
-
Defined in: [packages/ai-tool/src/funcs/event-server.ts:
|
|
331
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-server.ts:36](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/funcs/event-server.ts#L36)
|
|
332
|
+
|
|
333
|
+
The expected return type of the function, described as a string or a JSON schema object.
|
|
244
334
|
|
|
245
335
|
#### Overrides
|
|
246
336
|
|
|
@@ -252,7 +342,9 @@ Defined in: [packages/ai-tool/src/funcs/event-server.ts:29](https://github.com/i
|
|
|
252
342
|
|
|
253
343
|
> `optional` **scope**: `any`
|
|
254
344
|
|
|
255
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
345
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:91](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L91)
|
|
346
|
+
|
|
347
|
+
The execution scope or context (`this`) for the function.
|
|
256
348
|
|
|
257
349
|
#### Inherited from
|
|
258
350
|
|
|
@@ -264,7 +356,11 @@ Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-to
|
|
|
264
356
|
|
|
265
357
|
> `optional` **setup**: (`this`, `options`?) => `void`
|
|
266
358
|
|
|
267
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
359
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:114](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L114)
|
|
360
|
+
|
|
361
|
+
A lifecycle hook called once during the `ToolFunc` instance's initialization.
|
|
362
|
+
It allows for initial setup, state configuration, or property modification on the instance
|
|
363
|
+
before it is used or registered. The `this` context is the `ToolFunc` instance itself.
|
|
268
364
|
|
|
269
365
|
#### Parameters
|
|
270
366
|
|
|
@@ -276,10 +372,26 @@ Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-to
|
|
|
276
372
|
|
|
277
373
|
[`FuncItem`](../interfaces/FuncItem.md)
|
|
278
374
|
|
|
375
|
+
The configuration options for the function.
|
|
376
|
+
|
|
279
377
|
#### Returns
|
|
280
378
|
|
|
281
379
|
`void`
|
|
282
380
|
|
|
381
|
+
#### Example
|
|
382
|
+
|
|
383
|
+
```ts
|
|
384
|
+
const myFunc = new ToolFunc({
|
|
385
|
+
name: 'myFunc',
|
|
386
|
+
customState: 'initial',
|
|
387
|
+
setup() {
|
|
388
|
+
// `this` is the myFunc instance
|
|
389
|
+
this.customState = 'configured';
|
|
390
|
+
}
|
|
391
|
+
});
|
|
392
|
+
console.log(myFunc.customState); // Outputs: 'configured'
|
|
393
|
+
```
|
|
394
|
+
|
|
283
395
|
#### Inherited from
|
|
284
396
|
|
|
285
397
|
[`ResServerTools`](ResServerTools.md).[`setup`](ResServerTools.md#setup)
|
|
@@ -290,7 +402,10 @@ Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-to
|
|
|
290
402
|
|
|
291
403
|
> `optional` **stream**: `boolean`
|
|
292
404
|
|
|
293
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
405
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:125](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L125)
|
|
406
|
+
|
|
407
|
+
If true, indicates that the function has the *capability* to stream its output.
|
|
408
|
+
Whether a specific call is streamed is determined by a `stream` property in the runtime parameters.
|
|
294
409
|
|
|
295
410
|
#### Inherited from
|
|
296
411
|
|
|
@@ -302,7 +417,9 @@ Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-to
|
|
|
302
417
|
|
|
303
418
|
> `optional` **tags**: `string` \| `string`[]
|
|
304
419
|
|
|
305
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
420
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:96](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L96)
|
|
421
|
+
|
|
422
|
+
Tags for grouping or filtering functions.
|
|
306
423
|
|
|
307
424
|
#### Inherited from
|
|
308
425
|
|
|
@@ -310,11 +427,25 @@ Defined in: [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-to
|
|
|
310
427
|
|
|
311
428
|
***
|
|
312
429
|
|
|
313
|
-
###
|
|
430
|
+
### title?
|
|
431
|
+
|
|
432
|
+
> `optional` **title**: `string`
|
|
433
|
+
|
|
434
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:177](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L177)
|
|
435
|
+
|
|
436
|
+
A concise, human-readable title for the function, often used in UI or by AI.
|
|
437
|
+
|
|
438
|
+
#### Inherited from
|
|
439
|
+
|
|
440
|
+
[`ResServerTools`](ResServerTools.md).[`title`](ResServerTools.md#title)
|
|
441
|
+
|
|
442
|
+
***
|
|
443
|
+
|
|
444
|
+
### \_pubSubTransport
|
|
314
445
|
|
|
315
|
-
> `static` **\
|
|
446
|
+
> `static` **\_pubSubTransport**: `undefined` \| [`IPubSubServerTransport`](../interfaces/IPubSubServerTransport.md)
|
|
316
447
|
|
|
317
|
-
Defined in: [packages/ai-tool/src/funcs/event-server.ts:
|
|
448
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-server.ts:23](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/funcs/event-server.ts#L23)
|
|
318
449
|
|
|
319
450
|
***
|
|
320
451
|
|
|
@@ -322,7 +453,9 @@ Defined in: [packages/ai-tool/src/funcs/event-server.ts:19](https://github.com/i
|
|
|
322
453
|
|
|
323
454
|
> `static` **aliases**: `object` = `{}`
|
|
324
455
|
|
|
325
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
456
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:305](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L305)
|
|
457
|
+
|
|
458
|
+
A static map of aliases to their corresponding function names.
|
|
326
459
|
|
|
327
460
|
#### Index Signature
|
|
328
461
|
|
|
@@ -338,7 +471,11 @@ Defined in: [packages/ai-tool/src/tool-func.ts:58](https://github.com/isdk/ai-to
|
|
|
338
471
|
|
|
339
472
|
> `static` **dataPath**: `string`
|
|
340
473
|
|
|
341
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
474
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:312](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L312)
|
|
475
|
+
|
|
476
|
+
A conventional property to designate a file path for saving the registered `ToolFunc` data.
|
|
477
|
+
Note: The `ToolFunc` class itself does not implement persistence logic. It is up to the
|
|
478
|
+
developer to use this path to save and load the `ToolFunc.items` registry if needed.
|
|
342
479
|
|
|
343
480
|
#### Inherited from
|
|
344
481
|
|
|
@@ -346,33 +483,13 @@ Defined in: [packages/ai-tool/src/tool-func.ts:59](https://github.com/isdk/ai-to
|
|
|
346
483
|
|
|
347
484
|
***
|
|
348
485
|
|
|
349
|
-
### ebListener()
|
|
350
|
-
|
|
351
|
-
> `static` **ebListener**: (`this`, ...`data`) => `void`
|
|
352
|
-
|
|
353
|
-
Defined in: [packages/ai-tool/src/funcs/event-server.ts:42](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/funcs/event-server.ts#L42)
|
|
354
|
-
|
|
355
|
-
#### Parameters
|
|
356
|
-
|
|
357
|
-
##### this
|
|
358
|
-
|
|
359
|
-
`Event`
|
|
360
|
-
|
|
361
|
-
##### data
|
|
362
|
-
|
|
363
|
-
...`any`[]
|
|
364
|
-
|
|
365
|
-
#### Returns
|
|
366
|
-
|
|
367
|
-
`void`
|
|
368
|
-
|
|
369
|
-
***
|
|
370
|
-
|
|
371
486
|
### items
|
|
372
487
|
|
|
373
488
|
> `static` **items**: [`Funcs`](../interfaces/Funcs.md) = `{}`
|
|
374
489
|
|
|
375
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
490
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:300](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L300)
|
|
491
|
+
|
|
492
|
+
A static registry of all `ToolFunc` instances, indexed by name.
|
|
376
493
|
|
|
377
494
|
#### Inherited from
|
|
378
495
|
|
|
@@ -384,7 +501,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:57](https://github.com/isdk/ai-to
|
|
|
384
501
|
|
|
385
502
|
> `static` **SpecialRpcMethodNames**: `any`
|
|
386
503
|
|
|
387
|
-
Defined in: [packages/ai-tool/src/res-server-tools.ts:20](https://github.com/isdk/ai-tool.js/blob/
|
|
504
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-server-tools.ts:20](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/res-server-tools.ts#L20)
|
|
388
505
|
|
|
389
506
|
#### Inherited from
|
|
390
507
|
|
|
@@ -392,36 +509,36 @@ Defined in: [packages/ai-tool/src/res-server-tools.ts:20](https://github.com/isd
|
|
|
392
509
|
|
|
393
510
|
## Accessors
|
|
394
511
|
|
|
395
|
-
###
|
|
512
|
+
### pubSubTransport
|
|
396
513
|
|
|
397
514
|
#### Get Signature
|
|
398
515
|
|
|
399
|
-
> **get** **
|
|
516
|
+
> **get** **pubSubTransport**(): `undefined` \| [`IPubSubServerTransport`](../interfaces/IPubSubServerTransport.md)
|
|
400
517
|
|
|
401
|
-
Defined in: [packages/ai-tool/src/
|
|
518
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-server.ts:39](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/funcs/event-server.ts#L39)
|
|
402
519
|
|
|
403
520
|
##### Returns
|
|
404
521
|
|
|
405
|
-
`
|
|
406
|
-
|
|
407
|
-
#### Inherited from
|
|
408
|
-
|
|
409
|
-
[`ResServerTools`](ResServerTools.md).[`SpecialRpcMethodNames`](ResServerTools.md#specialrpcmethodnames-1)
|
|
522
|
+
`undefined` \| [`IPubSubServerTransport`](../interfaces/IPubSubServerTransport.md)
|
|
410
523
|
|
|
411
524
|
***
|
|
412
525
|
|
|
413
|
-
###
|
|
526
|
+
### SpecialRpcMethodNames
|
|
414
527
|
|
|
415
528
|
#### Get Signature
|
|
416
529
|
|
|
417
|
-
> **get** **
|
|
530
|
+
> **get** **SpecialRpcMethodNames**(): `any`
|
|
418
531
|
|
|
419
|
-
Defined in: [packages/ai-tool/src/
|
|
532
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-server-tool.ts:22](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/rpc-methods-server-tool.ts#L22)
|
|
420
533
|
|
|
421
534
|
##### Returns
|
|
422
535
|
|
|
423
536
|
`any`
|
|
424
537
|
|
|
538
|
+
#### Inherited from
|
|
539
|
+
|
|
540
|
+
[`ResServerTools`](ResServerTools.md).[`SpecialRpcMethodNames`](ResServerTools.md#specialrpcmethodnames-1)
|
|
541
|
+
|
|
425
542
|
***
|
|
426
543
|
|
|
427
544
|
### apiRoot
|
|
@@ -430,7 +547,9 @@ Defined in: [packages/ai-tool/src/funcs/event-server.ts:32](https://github.com/i
|
|
|
430
547
|
|
|
431
548
|
> **get** `static` **apiRoot**(): `undefined` \| `string`
|
|
432
549
|
|
|
433
|
-
Defined in: [packages/ai-tool/src/server-tools.ts:
|
|
550
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:57](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/server-tools.ts#L57)
|
|
551
|
+
|
|
552
|
+
The conventional root path for the API endpoint.
|
|
434
553
|
|
|
435
554
|
##### Returns
|
|
436
555
|
|
|
@@ -442,25 +561,25 @@ Defined in: [packages/ai-tool/src/server-tools.ts:26](https://github.com/isdk/ai
|
|
|
442
561
|
|
|
443
562
|
***
|
|
444
563
|
|
|
445
|
-
###
|
|
564
|
+
### pubSubTransport
|
|
446
565
|
|
|
447
566
|
#### Get Signature
|
|
448
567
|
|
|
449
|
-
> **get** `static` **
|
|
568
|
+
> **get** `static` **pubSubTransport**(): `undefined` \| [`IPubSubServerTransport`](../interfaces/IPubSubServerTransport.md)
|
|
450
569
|
|
|
451
|
-
Defined in: [packages/ai-tool/src/funcs/event-server.ts:
|
|
570
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-server.ts:25](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/funcs/event-server.ts#L25)
|
|
452
571
|
|
|
453
572
|
##### Returns
|
|
454
573
|
|
|
455
|
-
[`
|
|
574
|
+
`undefined` \| [`IPubSubServerTransport`](../interfaces/IPubSubServerTransport.md)
|
|
456
575
|
|
|
457
576
|
## Methods
|
|
458
577
|
|
|
459
578
|
### $publish()
|
|
460
579
|
|
|
461
|
-
> **$publish**(`__namedParameters`): `
|
|
580
|
+
> **$publish**(`__namedParameters`): `object`
|
|
462
581
|
|
|
463
|
-
Defined in: [packages/ai-tool/src/funcs/event-server.ts:
|
|
582
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-server.ts:130](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/funcs/event-server.ts#L130)
|
|
464
583
|
|
|
465
584
|
#### Parameters
|
|
466
585
|
|
|
@@ -470,15 +589,19 @@ Defined in: [packages/ai-tool/src/funcs/event-server.ts:113](https://github.com/
|
|
|
470
589
|
|
|
471
590
|
#### Returns
|
|
472
591
|
|
|
473
|
-
`
|
|
592
|
+
`object`
|
|
593
|
+
|
|
594
|
+
##### event
|
|
595
|
+
|
|
596
|
+
> **event**: `string`[] = `events`
|
|
474
597
|
|
|
475
598
|
***
|
|
476
599
|
|
|
477
600
|
### $sub()
|
|
478
601
|
|
|
479
|
-
> **$sub**(`__namedParameters`): `
|
|
602
|
+
> **$sub**(`__namedParameters`): `object`
|
|
480
603
|
|
|
481
|
-
Defined in: [packages/ai-tool/src/funcs/event-server.ts:
|
|
604
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-server.ts:112](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/funcs/event-server.ts#L112)
|
|
482
605
|
|
|
483
606
|
#### Parameters
|
|
484
607
|
|
|
@@ -488,15 +611,19 @@ Defined in: [packages/ai-tool/src/funcs/event-server.ts:95](https://github.com/i
|
|
|
488
611
|
|
|
489
612
|
#### Returns
|
|
490
613
|
|
|
491
|
-
`
|
|
614
|
+
`object`
|
|
615
|
+
|
|
616
|
+
##### event
|
|
617
|
+
|
|
618
|
+
> **event**: `string` \| `string`[]
|
|
492
619
|
|
|
493
620
|
***
|
|
494
621
|
|
|
495
622
|
### $unsub()
|
|
496
623
|
|
|
497
|
-
> **$unsub**(`__namedParameters`): `
|
|
624
|
+
> **$unsub**(`__namedParameters`): `object`
|
|
498
625
|
|
|
499
|
-
Defined in: [packages/ai-tool/src/funcs/event-server.ts:
|
|
626
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-server.ts:121](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/funcs/event-server.ts#L121)
|
|
500
627
|
|
|
501
628
|
#### Parameters
|
|
502
629
|
|
|
@@ -506,7 +633,11 @@ Defined in: [packages/ai-tool/src/funcs/event-server.ts:104](https://github.com/
|
|
|
506
633
|
|
|
507
634
|
#### Returns
|
|
508
635
|
|
|
509
|
-
`
|
|
636
|
+
`object`
|
|
637
|
+
|
|
638
|
+
##### event
|
|
639
|
+
|
|
640
|
+
> **event**: `string` \| `string`[]
|
|
510
641
|
|
|
511
642
|
***
|
|
512
643
|
|
|
@@ -514,7 +645,10 @@ Defined in: [packages/ai-tool/src/funcs/event-server.ts:104](https://github.com/
|
|
|
514
645
|
|
|
515
646
|
> **arr2ObjParams**(`params`): `any`[]
|
|
516
647
|
|
|
517
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
648
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:629](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L629)
|
|
649
|
+
|
|
650
|
+
Converts an array of positional arguments into a named parameters object.
|
|
651
|
+
This is used internally to support functions defined with named parameters.
|
|
518
652
|
|
|
519
653
|
#### Parameters
|
|
520
654
|
|
|
@@ -522,10 +656,14 @@ Defined in: [packages/ai-tool/src/tool-func.ts:269](https://github.com/isdk/ai-t
|
|
|
522
656
|
|
|
523
657
|
`any`[]
|
|
524
658
|
|
|
659
|
+
An array of positional arguments.
|
|
660
|
+
|
|
525
661
|
#### Returns
|
|
526
662
|
|
|
527
663
|
`any`[]
|
|
528
664
|
|
|
665
|
+
An array containing a single parameters object.
|
|
666
|
+
|
|
529
667
|
#### Inherited from
|
|
530
668
|
|
|
531
669
|
[`ResServerTools`](ResServerTools.md).[`arr2ObjParams`](ResServerTools.md#arr2objparams)
|
|
@@ -536,7 +674,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:269](https://github.com/isdk/ai-t
|
|
|
536
674
|
|
|
537
675
|
> **assign**(`src`, `options`?): `this`
|
|
538
676
|
|
|
539
|
-
Defined in:
|
|
677
|
+
Defined in: [property-manager.js/src/abstract.d.ts:106](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L106)
|
|
540
678
|
|
|
541
679
|
Assign the values from the src object.
|
|
542
680
|
|
|
@@ -568,7 +706,7 @@ this object
|
|
|
568
706
|
|
|
569
707
|
> **assignProperty**(`src`, `name`, `value`, `attrs`?, `options`?): `void`
|
|
570
708
|
|
|
571
|
-
Defined in:
|
|
709
|
+
Defined in: [property-manager.js/src/abstract.d.ts:117](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L117)
|
|
572
710
|
|
|
573
711
|
Assign a property of src to this object.
|
|
574
712
|
|
|
@@ -616,7 +754,7 @@ the attributes object
|
|
|
616
754
|
|
|
617
755
|
> `abstract` **assignPropertyTo**(`dest`, `src`, `name`, `value`, `attrs`?, `options`?): `void`
|
|
618
756
|
|
|
619
|
-
Defined in:
|
|
757
|
+
Defined in: [property-manager.js/src/abstract.d.ts:131](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L131)
|
|
620
758
|
|
|
621
759
|
Assign the property value from the src to destination object.
|
|
622
760
|
|
|
@@ -670,7 +808,7 @@ The attributes object of the property
|
|
|
670
808
|
|
|
671
809
|
> **assignTo**(`dest`?, `options`?): `any`
|
|
672
810
|
|
|
673
|
-
Defined in:
|
|
811
|
+
Defined in: [property-manager.js/src/abstract.d.ts:191](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L191)
|
|
674
812
|
|
|
675
813
|
Assign this attributes to the dest object
|
|
676
814
|
|
|
@@ -702,7 +840,7 @@ the dest object
|
|
|
702
840
|
|
|
703
841
|
> **cast**(`key`, `value`): `any`
|
|
704
842
|
|
|
705
|
-
Defined in: [packages/ai-tool/src/rpc-methods-server-tool.ts:48](https://github.com/isdk/ai-tool.js/blob/
|
|
843
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-server-tool.ts:48](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/rpc-methods-server-tool.ts#L48)
|
|
706
844
|
|
|
707
845
|
#### Parameters
|
|
708
846
|
|
|
@@ -728,7 +866,7 @@ Defined in: [packages/ai-tool/src/rpc-methods-server-tool.ts:48](https://github.
|
|
|
728
866
|
|
|
729
867
|
> **castParams**(`params`): `RpcMethodsServerFuncParams`
|
|
730
868
|
|
|
731
|
-
Defined in: [packages/ai-tool/src/res-server-tools.ts:40](https://github.com/isdk/ai-tool.js/blob/
|
|
869
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-server-tools.ts:40](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/res-server-tools.ts#L40)
|
|
732
870
|
|
|
733
871
|
#### Parameters
|
|
734
872
|
|
|
@@ -750,7 +888,7 @@ Defined in: [packages/ai-tool/src/res-server-tools.ts:40](https://github.com/isd
|
|
|
750
888
|
|
|
751
889
|
> **clone**(`options`?): `any`
|
|
752
890
|
|
|
753
|
-
Defined in:
|
|
891
|
+
Defined in: [property-manager.js/src/abstract.d.ts:155](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L155)
|
|
754
892
|
|
|
755
893
|
Create a new object with the same values of attributes.
|
|
756
894
|
|
|
@@ -776,7 +914,7 @@ the new object
|
|
|
776
914
|
|
|
777
915
|
> **cloneTo**(`dest`, `options`?): `any`
|
|
778
916
|
|
|
779
|
-
Defined in:
|
|
917
|
+
Defined in: [property-manager.js/src/abstract.d.ts:148](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L148)
|
|
780
918
|
|
|
781
919
|
Create and assign the values to the destination object.
|
|
782
920
|
|
|
@@ -808,7 +946,7 @@ the new dest object
|
|
|
808
946
|
|
|
809
947
|
> `abstract` **defineProperties**(`aProperties`): `any`
|
|
810
948
|
|
|
811
|
-
Defined in:
|
|
949
|
+
Defined in: [property-manager.js/src/abstract.d.ts:89](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L89)
|
|
812
950
|
|
|
813
951
|
Define the attributes of this object.
|
|
814
952
|
|
|
@@ -834,7 +972,7 @@ the defined attributes of the object
|
|
|
834
972
|
|
|
835
973
|
> `optional` **delete**(`__namedParameters`): `any`
|
|
836
974
|
|
|
837
|
-
Defined in: [packages/ai-tool/src/res-server-tools.ts:15](https://github.com/isdk/ai-tool.js/blob/
|
|
975
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-server-tools.ts:15](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/res-server-tools.ts#L15)
|
|
838
976
|
|
|
839
977
|
#### Parameters
|
|
840
978
|
|
|
@@ -856,7 +994,7 @@ Defined in: [packages/ai-tool/src/res-server-tools.ts:15](https://github.com/isd
|
|
|
856
994
|
|
|
857
995
|
> **exportTo**(`dest`, `options`?): `any`
|
|
858
996
|
|
|
859
|
-
Defined in:
|
|
997
|
+
Defined in: [property-manager.js/src/abstract.d.ts:173](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L173)
|
|
860
998
|
|
|
861
999
|
Export attributes to the dest json object.
|
|
862
1000
|
|
|
@@ -888,7 +1026,7 @@ the dest object.
|
|
|
888
1026
|
|
|
889
1027
|
> **forward**(`events`): `void`
|
|
890
1028
|
|
|
891
|
-
Defined in: [packages/ai-tool/src/funcs/event-server.ts:
|
|
1029
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-server.ts:77](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/funcs/event-server.ts#L77)
|
|
892
1030
|
|
|
893
1031
|
#### Parameters
|
|
894
1032
|
|
|
@@ -906,7 +1044,10 @@ Defined in: [packages/ai-tool/src/funcs/event-server.ts:69](https://github.com/i
|
|
|
906
1044
|
|
|
907
1045
|
> **func**(`params`): `any`
|
|
908
1046
|
|
|
909
|
-
Defined in: [packages/ai-tool/src/rpc-methods-server-tool.ts:68](https://github.com/isdk/ai-tool.js/blob/
|
|
1047
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-server-tool.ts:68](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/rpc-methods-server-tool.ts#L68)
|
|
1048
|
+
|
|
1049
|
+
Placeholder for the actual server-side function implementation.
|
|
1050
|
+
This method is intended to be defined when a `ServerTools` instance is created.
|
|
910
1051
|
|
|
911
1052
|
#### Parameters
|
|
912
1053
|
|
|
@@ -914,10 +1055,14 @@ Defined in: [packages/ai-tool/src/rpc-methods-server-tool.ts:68](https://github.
|
|
|
914
1055
|
|
|
915
1056
|
`RpcMethodsServerFuncParams`
|
|
916
1057
|
|
|
1058
|
+
The parameters for the function.
|
|
1059
|
+
|
|
917
1060
|
#### Returns
|
|
918
1061
|
|
|
919
1062
|
`any`
|
|
920
1063
|
|
|
1064
|
+
The result of the function.
|
|
1065
|
+
|
|
921
1066
|
#### Inherited from
|
|
922
1067
|
|
|
923
1068
|
[`ResServerTools`](ResServerTools.md).[`func`](ResServerTools.md#func)
|
|
@@ -928,7 +1073,7 @@ Defined in: [packages/ai-tool/src/rpc-methods-server-tool.ts:68](https://github.
|
|
|
928
1073
|
|
|
929
1074
|
> `optional` **get**(`__namedParameters`): `any`
|
|
930
1075
|
|
|
931
|
-
Defined in: [packages/ai-tool/src/res-server-tools.ts:12](https://github.com/isdk/ai-tool.js/blob/
|
|
1076
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-server-tools.ts:12](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/res-server-tools.ts#L12)
|
|
932
1077
|
|
|
933
1078
|
#### Parameters
|
|
934
1079
|
|
|
@@ -950,7 +1095,11 @@ Defined in: [packages/ai-tool/src/res-server-tools.ts:12](https://github.com/isd
|
|
|
950
1095
|
|
|
951
1096
|
> **getFunc**(`name`?): `any`
|
|
952
1097
|
|
|
953
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1098
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:720](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L720)
|
|
1099
|
+
|
|
1100
|
+
Gets a bound function reference for execution with named parameters.
|
|
1101
|
+
If a name is provided, it retrieves a different function from the registry.
|
|
1102
|
+
Otherwise, it returns a bound version of this instance's `runSync`.
|
|
954
1103
|
|
|
955
1104
|
#### Parameters
|
|
956
1105
|
|
|
@@ -958,10 +1107,14 @@ Defined in: [packages/ai-tool/src/tool-func.ts:322](https://github.com/isdk/ai-t
|
|
|
958
1107
|
|
|
959
1108
|
`string`
|
|
960
1109
|
|
|
1110
|
+
Optional name of the function to retrieve.
|
|
1111
|
+
|
|
961
1112
|
#### Returns
|
|
962
1113
|
|
|
963
1114
|
`any`
|
|
964
1115
|
|
|
1116
|
+
A function reference or `undefined` if not found.
|
|
1117
|
+
|
|
965
1118
|
#### Inherited from
|
|
966
1119
|
|
|
967
1120
|
[`ResServerTools`](ResServerTools.md).[`getFunc`](ResServerTools.md#getfunc)
|
|
@@ -972,7 +1125,11 @@ Defined in: [packages/ai-tool/src/tool-func.ts:322](https://github.com/isdk/ai-t
|
|
|
972
1125
|
|
|
973
1126
|
> **getFuncWithPos**(`name`?): `any`
|
|
974
1127
|
|
|
975
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1128
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:777](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L777)
|
|
1129
|
+
|
|
1130
|
+
Gets a bound function reference suitable for positional argument execution.
|
|
1131
|
+
If a name is provided, it retrieves a different function from the registry.
|
|
1132
|
+
Otherwise, it returns a bound version of this instance's `runWithPosSync`.
|
|
976
1133
|
|
|
977
1134
|
#### Parameters
|
|
978
1135
|
|
|
@@ -980,10 +1137,14 @@ Defined in: [packages/ai-tool/src/tool-func.ts:346](https://github.com/isdk/ai-t
|
|
|
980
1137
|
|
|
981
1138
|
`string`
|
|
982
1139
|
|
|
1140
|
+
Optional name of the function to retrieve.
|
|
1141
|
+
|
|
983
1142
|
#### Returns
|
|
984
1143
|
|
|
985
1144
|
`any`
|
|
986
1145
|
|
|
1146
|
+
A function reference or `undefined` if not found.
|
|
1147
|
+
|
|
987
1148
|
#### Inherited from
|
|
988
1149
|
|
|
989
1150
|
[`ResServerTools`](ResServerTools.md).[`getFuncWithPos`](ResServerTools.md#getfuncwithpos)
|
|
@@ -992,9 +1153,9 @@ Defined in: [packages/ai-tool/src/tool-func.ts:346](https://github.com/isdk/ai-t
|
|
|
992
1153
|
|
|
993
1154
|
### getMethodFromParams()
|
|
994
1155
|
|
|
995
|
-
> **getMethodFromParams**(`params`): `
|
|
1156
|
+
> **getMethodFromParams**(`params`): `any`
|
|
996
1157
|
|
|
997
|
-
Defined in: [packages/ai-tool/src/res-server-tools.ts:31](https://github.com/isdk/ai-tool.js/blob/
|
|
1158
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-server-tools.ts:31](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/res-server-tools.ts#L31)
|
|
998
1159
|
|
|
999
1160
|
#### Parameters
|
|
1000
1161
|
|
|
@@ -1004,7 +1165,7 @@ Defined in: [packages/ai-tool/src/res-server-tools.ts:31](https://github.com/isd
|
|
|
1004
1165
|
|
|
1005
1166
|
#### Returns
|
|
1006
1167
|
|
|
1007
|
-
`
|
|
1168
|
+
`any`
|
|
1008
1169
|
|
|
1009
1170
|
#### Inherited from
|
|
1010
1171
|
|
|
@@ -1016,7 +1177,7 @@ Defined in: [packages/ai-tool/src/res-server-tools.ts:31](https://github.com/isd
|
|
|
1016
1177
|
|
|
1017
1178
|
> `abstract` **getProperties**(): `PropDescriptors`
|
|
1018
1179
|
|
|
1019
|
-
Defined in:
|
|
1180
|
+
Defined in: [property-manager.js/src/abstract.d.ts:98](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L98)
|
|
1020
1181
|
|
|
1021
1182
|
Get the defined attributes.
|
|
1022
1183
|
|
|
@@ -1036,7 +1197,9 @@ the descriptors of properties object
|
|
|
1036
1197
|
|
|
1037
1198
|
> **hasAsyncFeature**(`feature`): `boolean`
|
|
1038
1199
|
|
|
1039
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1200
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:787](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L787)
|
|
1201
|
+
|
|
1202
|
+
Checks if the current function instance supports a specific async feature.
|
|
1040
1203
|
|
|
1041
1204
|
#### Parameters
|
|
1042
1205
|
|
|
@@ -1044,10 +1207,14 @@ Defined in: [packages/ai-tool/src/tool-func.ts:351](https://github.com/isdk/ai-t
|
|
|
1044
1207
|
|
|
1045
1208
|
[`AsyncFeatureBits`](../enumerations/AsyncFeatureBits.md)
|
|
1046
1209
|
|
|
1210
|
+
The async feature bit to check for.
|
|
1211
|
+
|
|
1047
1212
|
#### Returns
|
|
1048
1213
|
|
|
1049
1214
|
`boolean`
|
|
1050
1215
|
|
|
1216
|
+
`true` if the feature is supported, otherwise `false`.
|
|
1217
|
+
|
|
1051
1218
|
#### Inherited from
|
|
1052
1219
|
|
|
1053
1220
|
[`ResServerTools`](ResServerTools.md).[`hasAsyncFeature`](ResServerTools.md#hasasyncfeature)
|
|
@@ -1058,7 +1225,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:351](https://github.com/isdk/ai-t
|
|
|
1058
1225
|
|
|
1059
1226
|
> **hasOwnProperty**(`v`): `boolean`
|
|
1060
1227
|
|
|
1061
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:140
|
|
1228
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:140
|
|
1062
1229
|
|
|
1063
1230
|
Determines whether an object has a property with the specified name.
|
|
1064
1231
|
|
|
@@ -1084,7 +1251,7 @@ A property name.
|
|
|
1084
1251
|
|
|
1085
1252
|
> **initialize**(`src`?): `this`
|
|
1086
1253
|
|
|
1087
|
-
Defined in:
|
|
1254
|
+
Defined in: [property-manager.js/src/abstract.d.ts:139](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L139)
|
|
1088
1255
|
|
|
1089
1256
|
Initialize object and assign attribute values from src if src exists.
|
|
1090
1257
|
|
|
@@ -1110,7 +1277,7 @@ this object.
|
|
|
1110
1277
|
|
|
1111
1278
|
> **initRpcMethods**(`methods`): `void`
|
|
1112
1279
|
|
|
1113
|
-
Defined in: [packages/ai-tool/src/rpc-methods-server-tool.ts:27](https://github.com/isdk/ai-tool.js/blob/
|
|
1280
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-server-tool.ts:27](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/rpc-methods-server-tool.ts#L27)
|
|
1114
1281
|
|
|
1115
1282
|
#### Parameters
|
|
1116
1283
|
|
|
@@ -1132,7 +1299,7 @@ Defined in: [packages/ai-tool/src/rpc-methods-server-tool.ts:27](https://github.
|
|
|
1132
1299
|
|
|
1133
1300
|
> **isPrototypeOf**(`v`): `boolean`
|
|
1134
1301
|
|
|
1135
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:146
|
|
1302
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:146
|
|
1136
1303
|
|
|
1137
1304
|
Determines whether an object exists in another object's prototype chain.
|
|
1138
1305
|
|
|
@@ -1158,7 +1325,7 @@ Another object whose prototype chain is to be checked.
|
|
|
1158
1325
|
|
|
1159
1326
|
> **isSame**(`src`, `options`?): `boolean`
|
|
1160
1327
|
|
|
1161
|
-
Defined in:
|
|
1328
|
+
Defined in: [property-manager.js/src/abstract.d.ts:200](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L200)
|
|
1162
1329
|
|
|
1163
1330
|
Check the src object whether “equals” this object.
|
|
1164
1331
|
|
|
@@ -1188,7 +1355,15 @@ The source object
|
|
|
1188
1355
|
|
|
1189
1356
|
> **isStream**(`params`): `boolean`
|
|
1190
1357
|
|
|
1191
|
-
Defined in: [packages/ai-tool/src/funcs/event-server.ts:
|
|
1358
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-server.ts:144](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/funcs/event-server.ts#L144)
|
|
1359
|
+
|
|
1360
|
+
Determines if a function call should produce a stream.
|
|
1361
|
+
|
|
1362
|
+
The logic is as follows:
|
|
1363
|
+
1. It first checks if the function is generally capable of streaming (`this.stream`).
|
|
1364
|
+
2. If it is, it then checks if a `stream` parameter is formally declared in the function's `params` definition.
|
|
1365
|
+
3. If both are true, the method returns the value of the `stream` property from the runtime `params` object.
|
|
1366
|
+
Otherwise, it returns the function's static `stream` capability.
|
|
1192
1367
|
|
|
1193
1368
|
#### Parameters
|
|
1194
1369
|
|
|
@@ -1196,10 +1371,14 @@ Defined in: [packages/ai-tool/src/funcs/event-server.ts:127](https://github.com/
|
|
|
1196
1371
|
|
|
1197
1372
|
[`ServerFuncParams`](../interfaces/ServerFuncParams.md)
|
|
1198
1373
|
|
|
1374
|
+
The runtime parameters passed to the function call.
|
|
1375
|
+
|
|
1199
1376
|
#### Returns
|
|
1200
1377
|
|
|
1201
1378
|
`boolean`
|
|
1202
1379
|
|
|
1380
|
+
`true` if the call should be streamed, `false` or `undefined` otherwise.
|
|
1381
|
+
|
|
1203
1382
|
#### Overrides
|
|
1204
1383
|
|
|
1205
1384
|
[`ResServerTools`](ResServerTools.md).[`isStream`](ResServerTools.md#isstream)
|
|
@@ -1210,7 +1389,7 @@ Defined in: [packages/ai-tool/src/funcs/event-server.ts:127](https://github.com/
|
|
|
1210
1389
|
|
|
1211
1390
|
> **list**(`__namedParameters`): `void`
|
|
1212
1391
|
|
|
1213
|
-
Defined in: [packages/ai-tool/src/funcs/event-server.ts:
|
|
1392
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-server.ts:106](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/funcs/event-server.ts#L106)
|
|
1214
1393
|
|
|
1215
1394
|
#### Parameters
|
|
1216
1395
|
|
|
@@ -1232,7 +1411,7 @@ Defined in: [packages/ai-tool/src/funcs/event-server.ts:89](https://github.com/i
|
|
|
1232
1411
|
|
|
1233
1412
|
> **mergeTo**(`dest`, `options`?): `any`
|
|
1234
1413
|
|
|
1235
|
-
Defined in:
|
|
1414
|
+
Defined in: [property-manager.js/src/abstract.d.ts:164](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L164)
|
|
1236
1415
|
|
|
1237
1416
|
Merge this attributes to dest object.
|
|
1238
1417
|
|
|
@@ -1264,7 +1443,10 @@ the dest object.
|
|
|
1264
1443
|
|
|
1265
1444
|
> **obj2ArrParams**(`params`?): `any`[]
|
|
1266
1445
|
|
|
1267
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1446
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:648](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L648)
|
|
1447
|
+
|
|
1448
|
+
Converts a named parameters object into an array of positional arguments.
|
|
1449
|
+
This is used for functions defined with positional parameters.
|
|
1268
1450
|
|
|
1269
1451
|
#### Parameters
|
|
1270
1452
|
|
|
@@ -1272,10 +1454,14 @@ Defined in: [packages/ai-tool/src/tool-func.ts:282](https://github.com/isdk/ai-t
|
|
|
1272
1454
|
|
|
1273
1455
|
`any`
|
|
1274
1456
|
|
|
1457
|
+
A named parameters object.
|
|
1458
|
+
|
|
1275
1459
|
#### Returns
|
|
1276
1460
|
|
|
1277
1461
|
`any`[]
|
|
1278
1462
|
|
|
1463
|
+
An array of positional arguments.
|
|
1464
|
+
|
|
1279
1465
|
#### Inherited from
|
|
1280
1466
|
|
|
1281
1467
|
[`ResServerTools`](ResServerTools.md).[`obj2ArrParams`](ResServerTools.md#obj2arrparams)
|
|
@@ -1286,7 +1472,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:282](https://github.com/isdk/ai-t
|
|
|
1286
1472
|
|
|
1287
1473
|
> `optional` **post**(`options`): `any`
|
|
1288
1474
|
|
|
1289
|
-
Defined in: [packages/ai-tool/src/res-server-tools.ts:13](https://github.com/isdk/ai-tool.js/blob/
|
|
1475
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-server-tools.ts:13](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/res-server-tools.ts#L13)
|
|
1290
1476
|
|
|
1291
1477
|
#### Parameters
|
|
1292
1478
|
|
|
@@ -1308,7 +1494,7 @@ Defined in: [packages/ai-tool/src/res-server-tools.ts:13](https://github.com/isd
|
|
|
1308
1494
|
|
|
1309
1495
|
> **propertyIsEnumerable**(`v`): `boolean`
|
|
1310
1496
|
|
|
1311
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:152
|
|
1497
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:152
|
|
1312
1498
|
|
|
1313
1499
|
Determines whether a specified property is enumerable.
|
|
1314
1500
|
|
|
@@ -1334,7 +1520,7 @@ A property name.
|
|
|
1334
1520
|
|
|
1335
1521
|
> **publishSSE**(`data`, `event`): `any`
|
|
1336
1522
|
|
|
1337
|
-
Defined in: [packages/ai-tool/src/funcs/event-server.ts:
|
|
1523
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-server.ts:65](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/funcs/event-server.ts#L65)
|
|
1338
1524
|
|
|
1339
1525
|
#### Parameters
|
|
1340
1526
|
|
|
@@ -1356,7 +1542,7 @@ Defined in: [packages/ai-tool/src/funcs/event-server.ts:57](https://github.com/i
|
|
|
1356
1542
|
|
|
1357
1543
|
> `optional` **put**(`__namedParameters`): `any`
|
|
1358
1544
|
|
|
1359
|
-
Defined in: [packages/ai-tool/src/res-server-tools.ts:14](https://github.com/isdk/ai-tool.js/blob/
|
|
1545
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-server-tools.ts:14](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/res-server-tools.ts#L14)
|
|
1360
1546
|
|
|
1361
1547
|
#### Parameters
|
|
1362
1548
|
|
|
@@ -1378,12 +1564,17 @@ Defined in: [packages/ai-tool/src/res-server-tools.ts:14](https://github.com/isd
|
|
|
1378
1564
|
|
|
1379
1565
|
> **register**(): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
1380
1566
|
|
|
1381
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1567
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:602](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L602)
|
|
1568
|
+
|
|
1569
|
+
Registers the current `ToolFunc` instance into the static registry.
|
|
1570
|
+
Also registers any declared dependencies.
|
|
1382
1571
|
|
|
1383
1572
|
#### Returns
|
|
1384
1573
|
|
|
1385
1574
|
`boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
1386
1575
|
|
|
1576
|
+
The instance itself upon successful registration, or `false` if it already exists.
|
|
1577
|
+
|
|
1387
1578
|
#### Inherited from
|
|
1388
1579
|
|
|
1389
1580
|
[`ResServerTools`](ResServerTools.md).[`register`](ResServerTools.md#register)
|
|
@@ -1392,13 +1583,31 @@ Defined in: [packages/ai-tool/src/tool-func.ts:252](https://github.com/isdk/ai-t
|
|
|
1392
1583
|
|
|
1393
1584
|
### run()
|
|
1394
1585
|
|
|
1395
|
-
> **run**(`params`?): `Promise`\<`any`\>
|
|
1586
|
+
> **run**(`params`, `context`?): `Promise`\<`any`\>
|
|
1587
|
+
|
|
1588
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:98](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/server-tools.ts#L98)
|
|
1396
1589
|
|
|
1397
|
-
|
|
1590
|
+
Overrides the base `run` method to inject transport-specific context.
|
|
1591
|
+
If a `context` object containing `req` and `reply` is provided, these are
|
|
1592
|
+
added to the parameters as `_req` and `_res` before execution.
|
|
1398
1593
|
|
|
1399
1594
|
#### Parameters
|
|
1400
1595
|
|
|
1401
|
-
##### params
|
|
1596
|
+
##### params
|
|
1597
|
+
|
|
1598
|
+
[`ServerFuncParams`](../interfaces/ServerFuncParams.md)
|
|
1599
|
+
|
|
1600
|
+
The parameters for the function.
|
|
1601
|
+
|
|
1602
|
+
##### context?
|
|
1603
|
+
|
|
1604
|
+
The transport-level context.
|
|
1605
|
+
|
|
1606
|
+
###### reply
|
|
1607
|
+
|
|
1608
|
+
`any`
|
|
1609
|
+
|
|
1610
|
+
###### req
|
|
1402
1611
|
|
|
1403
1612
|
`any`
|
|
1404
1613
|
|
|
@@ -1406,6 +1615,8 @@ Defined in: [packages/ai-tool/src/tool-func.ts:309](https://github.com/isdk/ai-t
|
|
|
1406
1615
|
|
|
1407
1616
|
`Promise`\<`any`\>
|
|
1408
1617
|
|
|
1618
|
+
The result of the function execution.
|
|
1619
|
+
|
|
1409
1620
|
#### Inherited from
|
|
1410
1621
|
|
|
1411
1622
|
[`ResServerTools`](ResServerTools.md).[`run`](ResServerTools.md#run)
|
|
@@ -1416,7 +1627,10 @@ Defined in: [packages/ai-tool/src/tool-func.ts:309](https://github.com/isdk/ai-t
|
|
|
1416
1627
|
|
|
1417
1628
|
> **runAs**(`name`, `params`?): `Promise`\<`any`\>
|
|
1418
1629
|
|
|
1419
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1630
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:697](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L697)
|
|
1631
|
+
|
|
1632
|
+
Asynchronously executes another registered function by name.
|
|
1633
|
+
This method delegates to `runAsSync()` internally.
|
|
1420
1634
|
|
|
1421
1635
|
#### Parameters
|
|
1422
1636
|
|
|
@@ -1424,14 +1638,20 @@ Defined in: [packages/ai-tool/src/tool-func.ts:313](https://github.com/isdk/ai-t
|
|
|
1424
1638
|
|
|
1425
1639
|
`string`
|
|
1426
1640
|
|
|
1641
|
+
The name of the target function to run.
|
|
1642
|
+
|
|
1427
1643
|
##### params?
|
|
1428
1644
|
|
|
1429
1645
|
`any`
|
|
1430
1646
|
|
|
1647
|
+
Optional parameters to pass to the function.
|
|
1648
|
+
|
|
1431
1649
|
#### Returns
|
|
1432
1650
|
|
|
1433
1651
|
`Promise`\<`any`\>
|
|
1434
1652
|
|
|
1653
|
+
A promise that resolves with the result of the function execution.
|
|
1654
|
+
|
|
1435
1655
|
#### Inherited from
|
|
1436
1656
|
|
|
1437
1657
|
[`ResServerTools`](ResServerTools.md).[`runAs`](ResServerTools.md#runas)
|
|
@@ -1442,7 +1662,10 @@ Defined in: [packages/ai-tool/src/tool-func.ts:313](https://github.com/isdk/ai-t
|
|
|
1442
1662
|
|
|
1443
1663
|
> **runAsSync**(`name`, `params`?): `any`
|
|
1444
1664
|
|
|
1445
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1665
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:708](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L708)
|
|
1666
|
+
|
|
1667
|
+
Synchronously executes another registered function by name.
|
|
1668
|
+
This is a convenience method that forwards the call to the static `runSync()` method.
|
|
1446
1669
|
|
|
1447
1670
|
#### Parameters
|
|
1448
1671
|
|
|
@@ -1450,14 +1673,20 @@ Defined in: [packages/ai-tool/src/tool-func.ts:317](https://github.com/isdk/ai-t
|
|
|
1450
1673
|
|
|
1451
1674
|
`string`
|
|
1452
1675
|
|
|
1676
|
+
The name of the target function to run.
|
|
1677
|
+
|
|
1453
1678
|
##### params?
|
|
1454
1679
|
|
|
1455
1680
|
`any`
|
|
1456
1681
|
|
|
1682
|
+
Optional parameters to pass to the function.
|
|
1683
|
+
|
|
1457
1684
|
#### Returns
|
|
1458
1685
|
|
|
1459
1686
|
`any`
|
|
1460
1687
|
|
|
1688
|
+
The result of the function execution.
|
|
1689
|
+
|
|
1461
1690
|
#### Inherited from
|
|
1462
1691
|
|
|
1463
1692
|
[`ResServerTools`](ResServerTools.md).[`runAsSync`](ResServerTools.md#runassync)
|
|
@@ -1468,7 +1697,9 @@ Defined in: [packages/ai-tool/src/tool-func.ts:317](https://github.com/isdk/ai-t
|
|
|
1468
1697
|
|
|
1469
1698
|
> **runSync**(`params`?): `any`
|
|
1470
1699
|
|
|
1471
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1700
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:667](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L667)
|
|
1701
|
+
|
|
1702
|
+
Executes the function synchronously with a named parameters object.
|
|
1472
1703
|
|
|
1473
1704
|
#### Parameters
|
|
1474
1705
|
|
|
@@ -1476,10 +1707,18 @@ Defined in: [packages/ai-tool/src/tool-func.ts:295](https://github.com/isdk/ai-t
|
|
|
1476
1707
|
|
|
1477
1708
|
`any`
|
|
1478
1709
|
|
|
1710
|
+
The parameters object for the function.
|
|
1711
|
+
|
|
1479
1712
|
#### Returns
|
|
1480
1713
|
|
|
1481
1714
|
`any`
|
|
1482
1715
|
|
|
1716
|
+
The result of the function execution.
|
|
1717
|
+
|
|
1718
|
+
#### Throws
|
|
1719
|
+
|
|
1720
|
+
Will throw an error if an array of parameters is passed to a function that expects an object.
|
|
1721
|
+
|
|
1483
1722
|
#### Inherited from
|
|
1484
1723
|
|
|
1485
1724
|
[`ResServerTools`](ResServerTools.md).[`runSync`](ResServerTools.md#runsync)
|
|
@@ -1490,7 +1729,10 @@ Defined in: [packages/ai-tool/src/tool-func.ts:295](https://github.com/isdk/ai-t
|
|
|
1490
1729
|
|
|
1491
1730
|
> **runWithPos**(...`params`): `Promise`\<`any`\>
|
|
1492
1731
|
|
|
1493
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1732
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:755](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L755)
|
|
1733
|
+
|
|
1734
|
+
Executes the function asynchronously using positional arguments.
|
|
1735
|
+
Delegates to `runWithPosSync()` internally.
|
|
1494
1736
|
|
|
1495
1737
|
#### Parameters
|
|
1496
1738
|
|
|
@@ -1498,10 +1740,14 @@ Defined in: [packages/ai-tool/src/tool-func.ts:338](https://github.com/isdk/ai-t
|
|
|
1498
1740
|
|
|
1499
1741
|
...`any`[]
|
|
1500
1742
|
|
|
1743
|
+
Positional arguments passed to the function.
|
|
1744
|
+
|
|
1501
1745
|
#### Returns
|
|
1502
1746
|
|
|
1503
1747
|
`Promise`\<`any`\>
|
|
1504
1748
|
|
|
1749
|
+
A promise that resolves with the result of the function execution.
|
|
1750
|
+
|
|
1505
1751
|
#### Inherited from
|
|
1506
1752
|
|
|
1507
1753
|
[`ResServerTools`](ResServerTools.md).[`runWithPos`](ResServerTools.md#runwithpos)
|
|
@@ -1512,7 +1758,10 @@ Defined in: [packages/ai-tool/src/tool-func.ts:338](https://github.com/isdk/ai-t
|
|
|
1512
1758
|
|
|
1513
1759
|
> **runWithPosAs**(`name`, ...`params`): `Promise`\<`any`\>
|
|
1514
1760
|
|
|
1515
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1761
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:766](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L766)
|
|
1762
|
+
|
|
1763
|
+
Asynchronously executes another function by name using positional arguments.
|
|
1764
|
+
Delegates to `runWithPosAsSync()` internally.
|
|
1516
1765
|
|
|
1517
1766
|
#### Parameters
|
|
1518
1767
|
|
|
@@ -1520,14 +1769,20 @@ Defined in: [packages/ai-tool/src/tool-func.ts:342](https://github.com/isdk/ai-t
|
|
|
1520
1769
|
|
|
1521
1770
|
`string`
|
|
1522
1771
|
|
|
1772
|
+
The name of the target function to run.
|
|
1773
|
+
|
|
1523
1774
|
##### params
|
|
1524
1775
|
|
|
1525
1776
|
...`any`[]
|
|
1526
1777
|
|
|
1778
|
+
Positional arguments to pass to the function.
|
|
1779
|
+
|
|
1527
1780
|
#### Returns
|
|
1528
1781
|
|
|
1529
1782
|
`Promise`\<`any`\>
|
|
1530
1783
|
|
|
1784
|
+
A promise that resolves with the result of the function execution.
|
|
1785
|
+
|
|
1531
1786
|
#### Inherited from
|
|
1532
1787
|
|
|
1533
1788
|
[`ResServerTools`](ResServerTools.md).[`runWithPosAs`](ResServerTools.md#runwithposas)
|
|
@@ -1538,7 +1793,10 @@ Defined in: [packages/ai-tool/src/tool-func.ts:342](https://github.com/isdk/ai-t
|
|
|
1538
1793
|
|
|
1539
1794
|
> **runWithPosAsSync**(`name`, ...`params`): `any`
|
|
1540
1795
|
|
|
1541
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1796
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:745](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L745)
|
|
1797
|
+
|
|
1798
|
+
Synchronously executes another function by name using positional arguments.
|
|
1799
|
+
This is a convenience wrapper around the static `runWithPosSync()` method.
|
|
1542
1800
|
|
|
1543
1801
|
#### Parameters
|
|
1544
1802
|
|
|
@@ -1546,14 +1804,20 @@ Defined in: [packages/ai-tool/src/tool-func.ts:334](https://github.com/isdk/ai-t
|
|
|
1546
1804
|
|
|
1547
1805
|
`string`
|
|
1548
1806
|
|
|
1807
|
+
The name of the target function to run.
|
|
1808
|
+
|
|
1549
1809
|
##### params
|
|
1550
1810
|
|
|
1551
1811
|
...`any`[]
|
|
1552
1812
|
|
|
1813
|
+
Positional arguments to pass to the function.
|
|
1814
|
+
|
|
1553
1815
|
#### Returns
|
|
1554
1816
|
|
|
1555
1817
|
`any`
|
|
1556
1818
|
|
|
1819
|
+
The result of the function execution.
|
|
1820
|
+
|
|
1557
1821
|
#### Inherited from
|
|
1558
1822
|
|
|
1559
1823
|
[`ResServerTools`](ResServerTools.md).[`runWithPosAsSync`](ResServerTools.md#runwithposassync)
|
|
@@ -1564,7 +1828,10 @@ Defined in: [packages/ai-tool/src/tool-func.ts:334](https://github.com/isdk/ai-t
|
|
|
1564
1828
|
|
|
1565
1829
|
> **runWithPosSync**(...`params`): `any`
|
|
1566
1830
|
|
|
1567
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1831
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:731](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L731)
|
|
1832
|
+
|
|
1833
|
+
Executes the function synchronously using positional arguments.
|
|
1834
|
+
If the function expects named parameters, it converts the arguments automatically.
|
|
1568
1835
|
|
|
1569
1836
|
#### Parameters
|
|
1570
1837
|
|
|
@@ -1572,10 +1839,14 @@ Defined in: [packages/ai-tool/src/tool-func.ts:327](https://github.com/isdk/ai-t
|
|
|
1572
1839
|
|
|
1573
1840
|
...`any`[]
|
|
1574
1841
|
|
|
1842
|
+
Positional arguments passed to the function.
|
|
1843
|
+
|
|
1575
1844
|
#### Returns
|
|
1576
1845
|
|
|
1577
1846
|
`any`
|
|
1578
1847
|
|
|
1848
|
+
The result of the function execution.
|
|
1849
|
+
|
|
1579
1850
|
#### Inherited from
|
|
1580
1851
|
|
|
1581
1852
|
[`ResServerTools`](ResServerTools.md).[`runWithPosSync`](ResServerTools.md#runwithpossync)
|
|
@@ -1586,7 +1857,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:327](https://github.com/isdk/ai-t
|
|
|
1586
1857
|
|
|
1587
1858
|
> **subscribeSSE**(`req`, `res`, `events`?): `any`
|
|
1588
1859
|
|
|
1589
|
-
Defined in: [packages/ai-tool/src/funcs/event-server.ts:
|
|
1860
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-server.ts:69](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/funcs/event-server.ts#L69)
|
|
1590
1861
|
|
|
1591
1862
|
#### Parameters
|
|
1592
1863
|
|
|
@@ -1612,7 +1883,7 @@ Defined in: [packages/ai-tool/src/funcs/event-server.ts:61](https://github.com/i
|
|
|
1612
1883
|
|
|
1613
1884
|
> **toJSON**(): `any`
|
|
1614
1885
|
|
|
1615
|
-
Defined in:
|
|
1886
|
+
Defined in: [property-manager.js/src/abstract.d.ts:182](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L182)
|
|
1616
1887
|
|
|
1617
1888
|
#### Returns
|
|
1618
1889
|
|
|
@@ -1628,7 +1899,7 @@ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-ma
|
|
|
1628
1899
|
|
|
1629
1900
|
> **toLocaleString**(): `string`
|
|
1630
1901
|
|
|
1631
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:131
|
|
1902
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:131
|
|
1632
1903
|
|
|
1633
1904
|
Returns a date converted to a string using the current locale.
|
|
1634
1905
|
|
|
@@ -1646,7 +1917,7 @@ Returns a date converted to a string using the current locale.
|
|
|
1646
1917
|
|
|
1647
1918
|
> **toObject**(`options`?): `any`
|
|
1648
1919
|
|
|
1649
|
-
Defined in:
|
|
1920
|
+
Defined in: [property-manager.js/src/abstract.d.ts:181](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L181)
|
|
1650
1921
|
|
|
1651
1922
|
Convert the attributes to the json object
|
|
1652
1923
|
|
|
@@ -1672,7 +1943,7 @@ the json object.
|
|
|
1672
1943
|
|
|
1673
1944
|
> **toString**(): `string`
|
|
1674
1945
|
|
|
1675
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:128
|
|
1946
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:128
|
|
1676
1947
|
|
|
1677
1948
|
Returns a string representation of an object.
|
|
1678
1949
|
|
|
@@ -1690,7 +1961,7 @@ Returns a string representation of an object.
|
|
|
1690
1961
|
|
|
1691
1962
|
> **unforward**(`events`): `void`
|
|
1692
1963
|
|
|
1693
|
-
Defined in: [packages/ai-tool/src/funcs/event-server.ts:
|
|
1964
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-server.ts:94](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/funcs/event-server.ts#L94)
|
|
1694
1965
|
|
|
1695
1966
|
#### Parameters
|
|
1696
1967
|
|
|
@@ -1708,12 +1979,16 @@ Defined in: [packages/ai-tool/src/funcs/event-server.ts:80](https://github.com/i
|
|
|
1708
1979
|
|
|
1709
1980
|
> **unregister**(): `any`
|
|
1710
1981
|
|
|
1711
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1982
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:619](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L619)
|
|
1983
|
+
|
|
1984
|
+
Removes the current `ToolFunc` instance from the static registry.
|
|
1712
1985
|
|
|
1713
1986
|
#### Returns
|
|
1714
1987
|
|
|
1715
1988
|
`any`
|
|
1716
1989
|
|
|
1990
|
+
The instance that was unregistered.
|
|
1991
|
+
|
|
1717
1992
|
#### Inherited from
|
|
1718
1993
|
|
|
1719
1994
|
[`ResServerTools`](ResServerTools.md).[`unregister`](ResServerTools.md#unregister)
|
|
@@ -1724,7 +1999,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:265](https://github.com/isdk/ai-t
|
|
|
1724
1999
|
|
|
1725
2000
|
> **valueOf**(): `Object`
|
|
1726
2001
|
|
|
1727
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:134
|
|
2002
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:134
|
|
1728
2003
|
|
|
1729
2004
|
Returns the primitive value of the specified object.
|
|
1730
2005
|
|
|
@@ -1742,7 +2017,7 @@ Returns the primitive value of the specified object.
|
|
|
1742
2017
|
|
|
1743
2018
|
> `static` **alreadyForward**(`event`): `undefined` \| `true`
|
|
1744
2019
|
|
|
1745
|
-
Defined in: [packages/ai-tool/src/funcs/event-server.ts:
|
|
2020
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-server.ts:58](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/funcs/event-server.ts#L58)
|
|
1746
2021
|
|
|
1747
2022
|
#### Parameters
|
|
1748
2023
|
|
|
@@ -1762,7 +2037,7 @@ Defined in: [packages/ai-tool/src/funcs/event-server.ts:50](https://github.com/i
|
|
|
1762
2037
|
|
|
1763
2038
|
> `static` **assign**\<`T`, `U`\>(`target`, `source`): `T` & `U`
|
|
1764
2039
|
|
|
1765
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:286
|
|
2040
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:286
|
|
1766
2041
|
|
|
1767
2042
|
Copy the values of all of the enumerable own properties from one or more source objects to a
|
|
1768
2043
|
target object. Returns the target object.
|
|
@@ -1799,7 +2074,7 @@ The source object from which to copy properties.
|
|
|
1799
2074
|
|
|
1800
2075
|
> `static` **assign**\<`T`, `U`, `V`\>(`target`, `source1`, `source2`): `T` & `U` & `V`
|
|
1801
2076
|
|
|
1802
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:295
|
|
2077
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:295
|
|
1803
2078
|
|
|
1804
2079
|
Copy the values of all of the enumerable own properties from one or more source objects to a
|
|
1805
2080
|
target object. Returns the target object.
|
|
@@ -1844,7 +2119,7 @@ The second source object from which to copy properties.
|
|
|
1844
2119
|
|
|
1845
2120
|
> `static` **assign**\<`T`, `U`, `V`, `W`\>(`target`, `source1`, `source2`, `source3`): `T` & `U` & `V` & `W`
|
|
1846
2121
|
|
|
1847
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:305
|
|
2122
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:305
|
|
1848
2123
|
|
|
1849
2124
|
Copy the values of all of the enumerable own properties from one or more source objects to a
|
|
1850
2125
|
target object. Returns the target object.
|
|
@@ -1897,7 +2172,7 @@ The third source object from which to copy properties.
|
|
|
1897
2172
|
|
|
1898
2173
|
> `static` **assign**(`target`, ...`sources`): `any`
|
|
1899
2174
|
|
|
1900
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:313
|
|
2175
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:313
|
|
1901
2176
|
|
|
1902
2177
|
Copy the values of all of the enumerable own properties from one or more source objects to a
|
|
1903
2178
|
target object. Returns the target object.
|
|
@@ -1932,7 +2207,7 @@ One or more source objects from which to copy properties
|
|
|
1932
2207
|
|
|
1933
2208
|
> `static` **create**(`o`): `any`
|
|
1934
2209
|
|
|
1935
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:188
|
|
2210
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:188
|
|
1936
2211
|
|
|
1937
2212
|
Creates an object that has the specified prototype or that has null prototype.
|
|
1938
2213
|
|
|
@@ -1956,7 +2231,7 @@ Object to use as a prototype. May be null.
|
|
|
1956
2231
|
|
|
1957
2232
|
> `static` **create**(`o`, `properties`): `any`
|
|
1958
2233
|
|
|
1959
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:195
|
|
2234
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:195
|
|
1960
2235
|
|
|
1961
2236
|
Creates an object that has the specified prototype, and that optionally contains specified properties.
|
|
1962
2237
|
|
|
@@ -1988,7 +2263,7 @@ JavaScript object that contains one or more property descriptors.
|
|
|
1988
2263
|
|
|
1989
2264
|
> `static` **defineProperties**(`aTarget`, `aProperties`, `recreate`?): `any`
|
|
1990
2265
|
|
|
1991
|
-
Defined in:
|
|
2266
|
+
Defined in: [property-manager.js/src/advance.d.ts:11](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/advance.d.ts#L11)
|
|
1992
2267
|
|
|
1993
2268
|
Adds one or more properties to an object, and/or modifies attributes of existing properties.
|
|
1994
2269
|
|
|
@@ -2020,7 +2295,7 @@ Adds one or more properties to an object, and/or modifies attributes of existing
|
|
|
2020
2295
|
|
|
2021
2296
|
> `static` **defineProperty**\<`T`\>(`o`, `p`, `attributes`): `T`
|
|
2022
2297
|
|
|
2023
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:203
|
|
2298
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:203
|
|
2024
2299
|
|
|
2025
2300
|
Adds a property to an object, or modifies attributes of an existing property.
|
|
2026
2301
|
|
|
@@ -2058,13 +2333,35 @@ Descriptor for the property. It can be for a data property or an accessor proper
|
|
|
2058
2333
|
|
|
2059
2334
|
***
|
|
2060
2335
|
|
|
2336
|
+
### ebListener()
|
|
2337
|
+
|
|
2338
|
+
> `static` **ebListener**(`eventType`, ...`data`): `void`
|
|
2339
|
+
|
|
2340
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-server.ts:50](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/funcs/event-server.ts#L50)
|
|
2341
|
+
|
|
2342
|
+
#### Parameters
|
|
2343
|
+
|
|
2344
|
+
##### eventType
|
|
2345
|
+
|
|
2346
|
+
`string`
|
|
2347
|
+
|
|
2348
|
+
##### data
|
|
2349
|
+
|
|
2350
|
+
...`any`[]
|
|
2351
|
+
|
|
2352
|
+
#### Returns
|
|
2353
|
+
|
|
2354
|
+
`void`
|
|
2355
|
+
|
|
2356
|
+
***
|
|
2357
|
+
|
|
2061
2358
|
### entries()
|
|
2062
2359
|
|
|
2063
2360
|
#### Call Signature
|
|
2064
2361
|
|
|
2065
2362
|
> `static` **entries**\<`T`\>(`o`): \[`string`, `T`\][]
|
|
2066
2363
|
|
|
2067
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2017.object.d.ts:36
|
|
2364
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2017.object.d.ts:36
|
|
2068
2365
|
|
|
2069
2366
|
Returns an array of key/values of the enumerable own properties of an object
|
|
2070
2367
|
|
|
@@ -2092,7 +2389,7 @@ Object that contains the properties and methods. This can be an object that you
|
|
|
2092
2389
|
|
|
2093
2390
|
> `static` **entries**(`o`): \[`string`, `any`\][]
|
|
2094
2391
|
|
|
2095
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2017.object.d.ts:42
|
|
2392
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2017.object.d.ts:42
|
|
2096
2393
|
|
|
2097
2394
|
Returns an array of key/values of the enumerable own properties of an object
|
|
2098
2395
|
|
|
@@ -2118,7 +2415,7 @@ Object that contains the properties and methods. This can be an object that you
|
|
|
2118
2415
|
|
|
2119
2416
|
> `static` **freeze**\<`T`\>(`f`): `T`
|
|
2120
2417
|
|
|
2121
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:222
|
|
2418
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:222
|
|
2122
2419
|
|
|
2123
2420
|
Prevents the modification of existing property attributes and values, and prevents the addition of new properties.
|
|
2124
2421
|
|
|
@@ -2146,7 +2443,7 @@ Object on which to lock the attributes.
|
|
|
2146
2443
|
|
|
2147
2444
|
> `static` **freeze**\<`T`, `U`\>(`o`): `Readonly`\<`T`\>
|
|
2148
2445
|
|
|
2149
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:228
|
|
2446
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:228
|
|
2150
2447
|
|
|
2151
2448
|
Prevents the modification of existing property attributes and values, and prevents the addition of new properties.
|
|
2152
2449
|
|
|
@@ -2176,7 +2473,7 @@ Object on which to lock the attributes.
|
|
|
2176
2473
|
|
|
2177
2474
|
> `static` **freeze**\<`T`\>(`o`): `Readonly`\<`T`\>
|
|
2178
2475
|
|
|
2179
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:234
|
|
2476
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:234
|
|
2180
2477
|
|
|
2181
2478
|
Prevents the modification of existing property attributes and values, and prevents the addition of new properties.
|
|
2182
2479
|
|
|
@@ -2208,7 +2505,7 @@ Object on which to lock the attributes.
|
|
|
2208
2505
|
|
|
2209
2506
|
> `static` **fromEntries**\<`T`\>(`entries`): `object`
|
|
2210
2507
|
|
|
2211
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2019.object.d.ts:26
|
|
2508
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2019.object.d.ts:26
|
|
2212
2509
|
|
|
2213
2510
|
Returns an object created by key-value entries for properties and methods
|
|
2214
2511
|
|
|
@@ -2236,7 +2533,7 @@ An iterable object that contains key-value entries for properties and methods.
|
|
|
2236
2533
|
|
|
2237
2534
|
> `static` **fromEntries**(`entries`): `any`
|
|
2238
2535
|
|
|
2239
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2019.object.d.ts:32
|
|
2536
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2019.object.d.ts:32
|
|
2240
2537
|
|
|
2241
2538
|
Returns an object created by key-value entries for properties and methods
|
|
2242
2539
|
|
|
@@ -2262,7 +2559,9 @@ An iterable object that contains key-value entries for properties and methods.
|
|
|
2262
2559
|
|
|
2263
2560
|
> `static` **get**(`name`): [`ToolFunc`](ToolFunc.md)
|
|
2264
2561
|
|
|
2265
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
2562
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:319](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L319)
|
|
2563
|
+
|
|
2564
|
+
Retrieves a registered function by its name or alias.
|
|
2266
2565
|
|
|
2267
2566
|
#### Parameters
|
|
2268
2567
|
|
|
@@ -2270,10 +2569,14 @@ Defined in: [packages/ai-tool/src/tool-func.ts:61](https://github.com/isdk/ai-to
|
|
|
2270
2569
|
|
|
2271
2570
|
`string`
|
|
2272
2571
|
|
|
2572
|
+
The name or alias of the function to retrieve.
|
|
2573
|
+
|
|
2273
2574
|
#### Returns
|
|
2274
2575
|
|
|
2275
2576
|
[`ToolFunc`](ToolFunc.md)
|
|
2276
2577
|
|
|
2578
|
+
The `ToolFunc` instance if found, otherwise `undefined`.
|
|
2579
|
+
|
|
2277
2580
|
#### Inherited from
|
|
2278
2581
|
|
|
2279
2582
|
[`ResServerTools`](ResServerTools.md).[`get`](ResServerTools.md#get-2)
|
|
@@ -2284,7 +2587,9 @@ Defined in: [packages/ai-tool/src/tool-func.ts:61](https://github.com/isdk/ai-to
|
|
|
2284
2587
|
|
|
2285
2588
|
> `static` **getAllByTag**(`tagName`): [`ToolFunc`](ToolFunc.md)[]
|
|
2286
2589
|
|
|
2287
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
2590
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:365](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L365)
|
|
2591
|
+
|
|
2592
|
+
Retrieves all registered functions that have a specific tag.
|
|
2288
2593
|
|
|
2289
2594
|
#### Parameters
|
|
2290
2595
|
|
|
@@ -2292,10 +2597,14 @@ Defined in: [packages/ai-tool/src/tool-func.ts:93](https://github.com/isdk/ai-to
|
|
|
2292
2597
|
|
|
2293
2598
|
`string`
|
|
2294
2599
|
|
|
2600
|
+
The tag to search for.
|
|
2601
|
+
|
|
2295
2602
|
#### Returns
|
|
2296
2603
|
|
|
2297
2604
|
[`ToolFunc`](ToolFunc.md)[]
|
|
2298
2605
|
|
|
2606
|
+
An array of matching `ToolFunc` instances.
|
|
2607
|
+
|
|
2299
2608
|
#### Inherited from
|
|
2300
2609
|
|
|
2301
2610
|
[`ResServerTools`](ResServerTools.md).[`getAllByTag`](ResServerTools.md#getallbytag)
|
|
@@ -2306,7 +2615,9 @@ Defined in: [packages/ai-tool/src/tool-func.ts:93](https://github.com/isdk/ai-to
|
|
|
2306
2615
|
|
|
2307
2616
|
> `static` **getByTag**(`tagName`): `undefined` \| [`ToolFunc`](ToolFunc.md)
|
|
2308
2617
|
|
|
2309
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
2618
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:340](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L340)
|
|
2619
|
+
|
|
2620
|
+
Finds the first registered function that has a specific tag.
|
|
2310
2621
|
|
|
2311
2622
|
#### Parameters
|
|
2312
2623
|
|
|
@@ -2314,10 +2625,14 @@ Defined in: [packages/ai-tool/src/tool-func.ts:73](https://github.com/isdk/ai-to
|
|
|
2314
2625
|
|
|
2315
2626
|
`string`
|
|
2316
2627
|
|
|
2628
|
+
The tag to search for.
|
|
2629
|
+
|
|
2317
2630
|
#### Returns
|
|
2318
2631
|
|
|
2319
2632
|
`undefined` \| [`ToolFunc`](ToolFunc.md)
|
|
2320
2633
|
|
|
2634
|
+
The first matching `ToolFunc` instance, or `undefined` if none is found.
|
|
2635
|
+
|
|
2321
2636
|
#### Inherited from
|
|
2322
2637
|
|
|
2323
2638
|
[`ResServerTools`](ResServerTools.md).[`getByTag`](ResServerTools.md#getbytag)
|
|
@@ -2328,7 +2643,10 @@ Defined in: [packages/ai-tool/src/tool-func.ts:73](https://github.com/isdk/ai-to
|
|
|
2328
2643
|
|
|
2329
2644
|
> `static` **getFunc**(`name`): `any`
|
|
2330
2645
|
|
|
2331
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
2646
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:431](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L431)
|
|
2647
|
+
|
|
2648
|
+
Retrieves a bound, runnable function reference for a registered function.
|
|
2649
|
+
This reference is suitable for execution with an object of named parameters.
|
|
2332
2650
|
|
|
2333
2651
|
#### Parameters
|
|
2334
2652
|
|
|
@@ -2336,10 +2654,14 @@ Defined in: [packages/ai-tool/src/tool-func.ts:134](https://github.com/isdk/ai-t
|
|
|
2336
2654
|
|
|
2337
2655
|
`string`
|
|
2338
2656
|
|
|
2657
|
+
The name of the function.
|
|
2658
|
+
|
|
2339
2659
|
#### Returns
|
|
2340
2660
|
|
|
2341
2661
|
`any`
|
|
2342
2662
|
|
|
2663
|
+
A bound function reference, or `undefined` if not found.
|
|
2664
|
+
|
|
2343
2665
|
#### Inherited from
|
|
2344
2666
|
|
|
2345
2667
|
[`ResServerTools`](ResServerTools.md).[`getFunc`](ResServerTools.md#getfunc-2)
|
|
@@ -2350,7 +2672,10 @@ Defined in: [packages/ai-tool/src/tool-func.ts:134](https://github.com/isdk/ai-t
|
|
|
2350
2672
|
|
|
2351
2673
|
> `static` **getFuncWithPos**(`name`): `any`
|
|
2352
2674
|
|
|
2353
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
2675
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:472](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L472)
|
|
2676
|
+
|
|
2677
|
+
Retrieves a bound, runnable function reference for a registered function.
|
|
2678
|
+
This reference is suitable for execution with positional arguments.
|
|
2354
2679
|
|
|
2355
2680
|
#### Parameters
|
|
2356
2681
|
|
|
@@ -2358,10 +2683,14 @@ Defined in: [packages/ai-tool/src/tool-func.ts:155](https://github.com/isdk/ai-t
|
|
|
2358
2683
|
|
|
2359
2684
|
`string`
|
|
2360
2685
|
|
|
2686
|
+
The name of the function.
|
|
2687
|
+
|
|
2361
2688
|
#### Returns
|
|
2362
2689
|
|
|
2363
2690
|
`any`
|
|
2364
2691
|
|
|
2692
|
+
A bound function reference, or `undefined` if not found.
|
|
2693
|
+
|
|
2365
2694
|
#### Inherited from
|
|
2366
2695
|
|
|
2367
2696
|
[`ResServerTools`](ResServerTools.md).[`getFuncWithPos`](ResServerTools.md#getfuncwithpos-2)
|
|
@@ -2372,7 +2701,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:155](https://github.com/isdk/ai-t
|
|
|
2372
2701
|
|
|
2373
2702
|
> `static` **getOwnPropertyDescriptor**(`o`, `p`): `undefined` \| `PropertyDescriptor`
|
|
2374
2703
|
|
|
2375
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:175
|
|
2704
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:175
|
|
2376
2705
|
|
|
2377
2706
|
Gets the own property descriptor of the specified object.
|
|
2378
2707
|
An own property descriptor is one that is defined directly on the object and is not inherited from the object's prototype.
|
|
@@ -2405,7 +2734,7 @@ Name of the property.
|
|
|
2405
2734
|
|
|
2406
2735
|
> `static` **getOwnPropertyDescriptors**\<`T`\>(`o`): \{ \[P in string \| number \| symbol\]: TypedPropertyDescriptor\<T\[P\]\> \} & `object`
|
|
2407
2736
|
|
|
2408
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2017.object.d.ts:48
|
|
2737
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2017.object.d.ts:48
|
|
2409
2738
|
|
|
2410
2739
|
Returns an object containing all own property descriptors of an object
|
|
2411
2740
|
|
|
@@ -2435,7 +2764,7 @@ Object that contains the properties and methods. This can be an object that you
|
|
|
2435
2764
|
|
|
2436
2765
|
> `static` **getOwnPropertyNames**(`o`): `string`[]
|
|
2437
2766
|
|
|
2438
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:182
|
|
2767
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:182
|
|
2439
2768
|
|
|
2440
2769
|
Returns the names of the own properties of an object. The own properties of an object are those that are defined directly
|
|
2441
2770
|
on that object, and are not inherited from the object's prototype. The properties of an object include both fields (objects) and functions.
|
|
@@ -2462,7 +2791,7 @@ Object that contains the own properties.
|
|
|
2462
2791
|
|
|
2463
2792
|
> `static` **getOwnPropertySymbols**(`o`): `symbol`[]
|
|
2464
2793
|
|
|
2465
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:319
|
|
2794
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:319
|
|
2466
2795
|
|
|
2467
2796
|
Returns an array of all symbol properties found directly on object o.
|
|
2468
2797
|
|
|
@@ -2488,7 +2817,7 @@ Object to retrieve the symbols from.
|
|
|
2488
2817
|
|
|
2489
2818
|
> `static` **getProperties**(): `PropDescriptors`
|
|
2490
2819
|
|
|
2491
|
-
Defined in:
|
|
2820
|
+
Defined in: [property-manager.js/src/advance.d.ts:10](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/advance.d.ts#L10)
|
|
2492
2821
|
|
|
2493
2822
|
get all properties descriptor include inherited.
|
|
2494
2823
|
|
|
@@ -2506,7 +2835,7 @@ get all properties descriptor include inherited.
|
|
|
2506
2835
|
|
|
2507
2836
|
> `static` **getPrototypeOf**(`o`): `any`
|
|
2508
2837
|
|
|
2509
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:167
|
|
2838
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:167
|
|
2510
2839
|
|
|
2511
2840
|
Returns the prototype of an object.
|
|
2512
2841
|
|
|
@@ -2532,7 +2861,9 @@ The object that references the prototype.
|
|
|
2532
2861
|
|
|
2533
2862
|
> `static` **hasAsyncFeature**(`feature`): `boolean`
|
|
2534
2863
|
|
|
2535
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
2864
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:388](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L388)
|
|
2865
|
+
|
|
2866
|
+
Checks if any registered function has a specific asynchronous feature.
|
|
2536
2867
|
|
|
2537
2868
|
#### Parameters
|
|
2538
2869
|
|
|
@@ -2540,10 +2871,14 @@ Defined in: [packages/ai-tool/src/tool-func.ts:111](https://github.com/isdk/ai-t
|
|
|
2540
2871
|
|
|
2541
2872
|
[`AsyncFeatureBits`](../enumerations/AsyncFeatureBits.md)
|
|
2542
2873
|
|
|
2874
|
+
The async feature bit to check for.
|
|
2875
|
+
|
|
2543
2876
|
#### Returns
|
|
2544
2877
|
|
|
2545
2878
|
`boolean`
|
|
2546
2879
|
|
|
2880
|
+
`true` if the feature is present in any function, otherwise `false`.
|
|
2881
|
+
|
|
2547
2882
|
#### Inherited from
|
|
2548
2883
|
|
|
2549
2884
|
[`ResServerTools`](ResServerTools.md).[`hasAsyncFeature`](ResServerTools.md#hasasyncfeature-2)
|
|
@@ -2554,7 +2889,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:111](https://github.com/isdk/ai-t
|
|
|
2554
2889
|
|
|
2555
2890
|
> `static` **hasOwn**(`o`, `v`): `boolean`
|
|
2556
2891
|
|
|
2557
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2022.object.d.ts:25
|
|
2892
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2022.object.d.ts:25
|
|
2558
2893
|
|
|
2559
2894
|
Determines whether an object has a property with the specified name.
|
|
2560
2895
|
|
|
@@ -2586,7 +2921,7 @@ A property name.
|
|
|
2586
2921
|
|
|
2587
2922
|
> `static` **is**(`value1`, `value2`): `boolean`
|
|
2588
2923
|
|
|
2589
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:332
|
|
2924
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:332
|
|
2590
2925
|
|
|
2591
2926
|
Returns true if the values are the same value, false otherwise.
|
|
2592
2927
|
|
|
@@ -2618,7 +2953,7 @@ The second value.
|
|
|
2618
2953
|
|
|
2619
2954
|
> `static` **isExtensible**(`o`): `boolean`
|
|
2620
2955
|
|
|
2621
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:258
|
|
2956
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:258
|
|
2622
2957
|
|
|
2623
2958
|
Returns a value that indicates whether new properties can be added to an object.
|
|
2624
2959
|
|
|
@@ -2644,7 +2979,7 @@ Object to test.
|
|
|
2644
2979
|
|
|
2645
2980
|
> `static` **isFrozen**(`o`): `boolean`
|
|
2646
2981
|
|
|
2647
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:252
|
|
2982
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:252
|
|
2648
2983
|
|
|
2649
2984
|
Returns true if existing property attributes and values cannot be modified in an object, and new properties cannot be added to the object.
|
|
2650
2985
|
|
|
@@ -2670,7 +3005,7 @@ Object to test.
|
|
|
2670
3005
|
|
|
2671
3006
|
> `static` **isSealed**(`o`): `boolean`
|
|
2672
3007
|
|
|
2673
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:246
|
|
3008
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:246
|
|
2674
3009
|
|
|
2675
3010
|
Returns true if existing property attributes cannot be modified in an object and new properties cannot be added to the object.
|
|
2676
3011
|
|
|
@@ -2698,7 +3033,7 @@ Object to test.
|
|
|
2698
3033
|
|
|
2699
3034
|
> `static` **keys**(`o`): `string`[]
|
|
2700
3035
|
|
|
2701
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:264
|
|
3036
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:264
|
|
2702
3037
|
|
|
2703
3038
|
Returns the names of the enumerable string properties and methods of an object.
|
|
2704
3039
|
|
|
@@ -2722,7 +3057,7 @@ Object that contains the properties and methods. This can be an object that you
|
|
|
2722
3057
|
|
|
2723
3058
|
> `static` **keys**(`o`): `string`[]
|
|
2724
3059
|
|
|
2725
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:325
|
|
3060
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:325
|
|
2726
3061
|
|
|
2727
3062
|
Returns the names of the enumerable string properties and methods of an object.
|
|
2728
3063
|
|
|
@@ -2746,12 +3081,16 @@ Object that contains the properties and methods. This can be an object that you
|
|
|
2746
3081
|
|
|
2747
3082
|
> `static` **list**(): [`Funcs`](../interfaces/Funcs.md)
|
|
2748
3083
|
|
|
2749
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
3084
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:331](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L331)
|
|
3085
|
+
|
|
3086
|
+
Returns the complete map of all registered functions.
|
|
2750
3087
|
|
|
2751
3088
|
#### Returns
|
|
2752
3089
|
|
|
2753
3090
|
[`Funcs`](../interfaces/Funcs.md)
|
|
2754
3091
|
|
|
3092
|
+
The map of `ToolFunc` instances.
|
|
3093
|
+
|
|
2755
3094
|
#### Inherited from
|
|
2756
3095
|
|
|
2757
3096
|
[`ResServerTools`](ResServerTools.md).[`list`](ResServerTools.md#list-2)
|
|
@@ -2762,7 +3101,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:69](https://github.com/isdk/ai-to
|
|
|
2762
3101
|
|
|
2763
3102
|
> `static` **preventExtensions**\<`T`\>(`o`): `T`
|
|
2764
3103
|
|
|
2765
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:240
|
|
3104
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:240
|
|
2766
3105
|
|
|
2767
3106
|
Prevents the addition of new properties to an object.
|
|
2768
3107
|
|
|
@@ -2790,9 +3129,9 @@ Object to make non-extensible.
|
|
|
2790
3129
|
|
|
2791
3130
|
### publish()
|
|
2792
3131
|
|
|
2793
|
-
> `static` **publish**(`data`, `event`): `undefined` \| `
|
|
3132
|
+
> `static` **publish**(`data`, `event`, `target`?): `undefined` \| `void`
|
|
2794
3133
|
|
|
2795
|
-
Defined in: [packages/ai-tool/src/funcs/event-server.ts:
|
|
3134
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-server.ts:43](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/funcs/event-server.ts#L43)
|
|
2796
3135
|
|
|
2797
3136
|
#### Parameters
|
|
2798
3137
|
|
|
@@ -2804,9 +3143,15 @@ Defined in: [packages/ai-tool/src/funcs/event-server.ts:36](https://github.com/i
|
|
|
2804
3143
|
|
|
2805
3144
|
`string`
|
|
2806
3145
|
|
|
3146
|
+
##### target?
|
|
3147
|
+
|
|
3148
|
+
###### clientId?
|
|
3149
|
+
|
|
3150
|
+
`string` \| `string`[]
|
|
3151
|
+
|
|
2807
3152
|
#### Returns
|
|
2808
3153
|
|
|
2809
|
-
`undefined` \| `
|
|
3154
|
+
`undefined` \| `void`
|
|
2810
3155
|
|
|
2811
3156
|
***
|
|
2812
3157
|
|
|
@@ -2816,7 +3161,9 @@ Defined in: [packages/ai-tool/src/funcs/event-server.ts:36](https://github.com/i
|
|
|
2816
3161
|
|
|
2817
3162
|
> `static` **register**(`name`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2818
3163
|
|
|
2819
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
3164
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:495](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L495)
|
|
3165
|
+
|
|
3166
|
+
Registers a new tool function.
|
|
2820
3167
|
|
|
2821
3168
|
##### Parameters
|
|
2822
3169
|
|
|
@@ -2824,14 +3171,24 @@ Defined in: [packages/ai-tool/src/tool-func.ts:160](https://github.com/isdk/ai-t
|
|
|
2824
3171
|
|
|
2825
3172
|
`string`
|
|
2826
3173
|
|
|
3174
|
+
The name of the function.
|
|
3175
|
+
|
|
2827
3176
|
###### options
|
|
2828
3177
|
|
|
2829
3178
|
[`FuncItem`](../interfaces/FuncItem.md)
|
|
2830
3179
|
|
|
3180
|
+
The function's configuration.
|
|
3181
|
+
|
|
2831
3182
|
##### Returns
|
|
2832
3183
|
|
|
2833
3184
|
`boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2834
3185
|
|
|
3186
|
+
The new `ToolFunc` instance, or `false` if a function with that name already exists.
|
|
3187
|
+
|
|
3188
|
+
The new `ToolFunc` instance, or `false` if a function with that name already exists.
|
|
3189
|
+
|
|
3190
|
+
The new `ToolFunc` instance, or `false` if a function with that name already exists.
|
|
3191
|
+
|
|
2835
3192
|
##### Inherited from
|
|
2836
3193
|
|
|
2837
3194
|
[`ResServerTools`](ResServerTools.md).[`register`](ResServerTools.md#register-2)
|
|
@@ -2840,7 +3197,9 @@ Defined in: [packages/ai-tool/src/tool-func.ts:160](https://github.com/isdk/ai-t
|
|
|
2840
3197
|
|
|
2841
3198
|
> `static` **register**(`func`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2842
3199
|
|
|
2843
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
3200
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:496](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L496)
|
|
3201
|
+
|
|
3202
|
+
Registers a new tool function.
|
|
2844
3203
|
|
|
2845
3204
|
##### Parameters
|
|
2846
3205
|
|
|
@@ -2848,14 +3207,24 @@ Defined in: [packages/ai-tool/src/tool-func.ts:161](https://github.com/isdk/ai-t
|
|
|
2848
3207
|
|
|
2849
3208
|
`Function`
|
|
2850
3209
|
|
|
3210
|
+
The function implementation.
|
|
3211
|
+
|
|
2851
3212
|
###### options
|
|
2852
3213
|
|
|
2853
3214
|
[`FuncItem`](../interfaces/FuncItem.md)
|
|
2854
3215
|
|
|
3216
|
+
The function's configuration.
|
|
3217
|
+
|
|
2855
3218
|
##### Returns
|
|
2856
3219
|
|
|
2857
3220
|
`boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2858
3221
|
|
|
3222
|
+
The new `ToolFunc` instance, or `false` if a function with that name already exists.
|
|
3223
|
+
|
|
3224
|
+
The new `ToolFunc` instance, or `false` if a function with that name already exists.
|
|
3225
|
+
|
|
3226
|
+
The new `ToolFunc` instance, or `false` if a function with that name already exists.
|
|
3227
|
+
|
|
2859
3228
|
##### Inherited from
|
|
2860
3229
|
|
|
2861
3230
|
[`ResServerTools`](ResServerTools.md).[`register`](ResServerTools.md#register-2)
|
|
@@ -2864,22 +3233,34 @@ Defined in: [packages/ai-tool/src/tool-func.ts:161](https://github.com/isdk/ai-t
|
|
|
2864
3233
|
|
|
2865
3234
|
> `static` **register**(`name`, `options`?): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2866
3235
|
|
|
2867
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
3236
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:497](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L497)
|
|
3237
|
+
|
|
3238
|
+
Registers a new tool function.
|
|
2868
3239
|
|
|
2869
3240
|
##### Parameters
|
|
2870
3241
|
|
|
2871
3242
|
###### name
|
|
2872
3243
|
|
|
3244
|
+
The name of the function.
|
|
3245
|
+
|
|
2873
3246
|
`string` | `Function` | [`ToolFunc`](ToolFunc.md) | [`FuncItem`](../interfaces/FuncItem.md)
|
|
2874
3247
|
|
|
2875
3248
|
###### options?
|
|
2876
3249
|
|
|
2877
3250
|
[`FuncItem`](../interfaces/FuncItem.md)
|
|
2878
3251
|
|
|
3252
|
+
The function's configuration.
|
|
3253
|
+
|
|
2879
3254
|
##### Returns
|
|
2880
3255
|
|
|
2881
3256
|
`boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2882
3257
|
|
|
3258
|
+
The new `ToolFunc` instance, or `false` if a function with that name already exists.
|
|
3259
|
+
|
|
3260
|
+
The new `ToolFunc` instance, or `false` if a function with that name already exists.
|
|
3261
|
+
|
|
3262
|
+
The new `ToolFunc` instance, or `false` if a function with that name already exists.
|
|
3263
|
+
|
|
2883
3264
|
##### Inherited from
|
|
2884
3265
|
|
|
2885
3266
|
[`ResServerTools`](ResServerTools.md).[`register`](ResServerTools.md#register-2)
|
|
@@ -2890,7 +3271,9 @@ Defined in: [packages/ai-tool/src/tool-func.ts:162](https://github.com/isdk/ai-t
|
|
|
2890
3271
|
|
|
2891
3272
|
> `static` **run**(`name`, `params`?): `Promise`\<`any`\>
|
|
2892
3273
|
|
|
2893
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
3274
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:402](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L402)
|
|
3275
|
+
|
|
3276
|
+
Asynchronously executes a registered function by name with named parameters.
|
|
2894
3277
|
|
|
2895
3278
|
#### Parameters
|
|
2896
3279
|
|
|
@@ -2898,14 +3281,24 @@ Defined in: [packages/ai-tool/src/tool-func.ts:118](https://github.com/isdk/ai-t
|
|
|
2898
3281
|
|
|
2899
3282
|
`string`
|
|
2900
3283
|
|
|
3284
|
+
The name of the function to run.
|
|
3285
|
+
|
|
2901
3286
|
##### params?
|
|
2902
3287
|
|
|
2903
3288
|
`any`
|
|
2904
3289
|
|
|
3290
|
+
The parameters object for the function.
|
|
3291
|
+
|
|
2905
3292
|
#### Returns
|
|
2906
3293
|
|
|
2907
3294
|
`Promise`\<`any`\>
|
|
2908
3295
|
|
|
3296
|
+
A promise that resolves with the function's result.
|
|
3297
|
+
|
|
3298
|
+
#### Throws
|
|
3299
|
+
|
|
3300
|
+
If the function with the given name is not found.
|
|
3301
|
+
|
|
2909
3302
|
#### Inherited from
|
|
2910
3303
|
|
|
2911
3304
|
[`ResServerTools`](ResServerTools.md).[`run`](ResServerTools.md#run-2)
|
|
@@ -2916,7 +3309,9 @@ Defined in: [packages/ai-tool/src/tool-func.ts:118](https://github.com/isdk/ai-t
|
|
|
2916
3309
|
|
|
2917
3310
|
> `static` **runSync**(`name`, `params`?): `any`
|
|
2918
3311
|
|
|
2919
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
3312
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:417](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L417)
|
|
3313
|
+
|
|
3314
|
+
Synchronously executes a registered function by name with named parameters.
|
|
2920
3315
|
|
|
2921
3316
|
#### Parameters
|
|
2922
3317
|
|
|
@@ -2924,14 +3319,24 @@ Defined in: [packages/ai-tool/src/tool-func.ts:126](https://github.com/isdk/ai-t
|
|
|
2924
3319
|
|
|
2925
3320
|
`string`
|
|
2926
3321
|
|
|
3322
|
+
The name of the function to run.
|
|
3323
|
+
|
|
2927
3324
|
##### params?
|
|
2928
3325
|
|
|
2929
3326
|
`any`
|
|
2930
3327
|
|
|
3328
|
+
The parameters object for the function.
|
|
3329
|
+
|
|
2931
3330
|
#### Returns
|
|
2932
3331
|
|
|
2933
3332
|
`any`
|
|
2934
3333
|
|
|
3334
|
+
The result of the function's execution.
|
|
3335
|
+
|
|
3336
|
+
#### Throws
|
|
3337
|
+
|
|
3338
|
+
If the function with the given name is not found.
|
|
3339
|
+
|
|
2935
3340
|
#### Inherited from
|
|
2936
3341
|
|
|
2937
3342
|
[`ResServerTools`](ResServerTools.md).[`runSync`](ResServerTools.md#runsync-2)
|
|
@@ -2942,7 +3347,9 @@ Defined in: [packages/ai-tool/src/tool-func.ts:126](https://github.com/isdk/ai-t
|
|
|
2942
3347
|
|
|
2943
3348
|
> `static` **runWithPos**(`name`, ...`params`): `Promise`\<`any`\>
|
|
2944
3349
|
|
|
2945
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
3350
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:443](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L443)
|
|
3351
|
+
|
|
3352
|
+
Asynchronously executes a function using positional arguments.
|
|
2946
3353
|
|
|
2947
3354
|
#### Parameters
|
|
2948
3355
|
|
|
@@ -2950,14 +3357,24 @@ Defined in: [packages/ai-tool/src/tool-func.ts:139](https://github.com/isdk/ai-t
|
|
|
2950
3357
|
|
|
2951
3358
|
`string`
|
|
2952
3359
|
|
|
3360
|
+
The name of the function to run.
|
|
3361
|
+
|
|
2953
3362
|
##### params
|
|
2954
3363
|
|
|
2955
3364
|
...`any`[]
|
|
2956
3365
|
|
|
3366
|
+
Positional arguments to pass to the function.
|
|
3367
|
+
|
|
2957
3368
|
#### Returns
|
|
2958
3369
|
|
|
2959
3370
|
`Promise`\<`any`\>
|
|
2960
3371
|
|
|
3372
|
+
A promise that resolves with the function's result.
|
|
3373
|
+
|
|
3374
|
+
#### Throws
|
|
3375
|
+
|
|
3376
|
+
If the function with the given name is not found.
|
|
3377
|
+
|
|
2961
3378
|
#### Inherited from
|
|
2962
3379
|
|
|
2963
3380
|
[`ResServerTools`](ResServerTools.md).[`runWithPos`](ResServerTools.md#runwithpos-2)
|
|
@@ -2968,7 +3385,9 @@ Defined in: [packages/ai-tool/src/tool-func.ts:139](https://github.com/isdk/ai-t
|
|
|
2968
3385
|
|
|
2969
3386
|
> `static` **runWithPosSync**(`name`, ...`params`): `any`
|
|
2970
3387
|
|
|
2971
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
3388
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:458](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L458)
|
|
3389
|
+
|
|
3390
|
+
Synchronously executes a function using positional arguments.
|
|
2972
3391
|
|
|
2973
3392
|
#### Parameters
|
|
2974
3393
|
|
|
@@ -2976,14 +3395,24 @@ Defined in: [packages/ai-tool/src/tool-func.ts:147](https://github.com/isdk/ai-t
|
|
|
2976
3395
|
|
|
2977
3396
|
`string`
|
|
2978
3397
|
|
|
3398
|
+
The name of the function to run.
|
|
3399
|
+
|
|
2979
3400
|
##### params
|
|
2980
3401
|
|
|
2981
3402
|
...`any`[]
|
|
2982
3403
|
|
|
3404
|
+
Positional arguments to pass to the function.
|
|
3405
|
+
|
|
2983
3406
|
#### Returns
|
|
2984
3407
|
|
|
2985
3408
|
`any`
|
|
2986
3409
|
|
|
3410
|
+
The result of the function's execution.
|
|
3411
|
+
|
|
3412
|
+
#### Throws
|
|
3413
|
+
|
|
3414
|
+
If the function with the given name is not found.
|
|
3415
|
+
|
|
2987
3416
|
#### Inherited from
|
|
2988
3417
|
|
|
2989
3418
|
[`ResServerTools`](ResServerTools.md).[`runWithPosSync`](ResServerTools.md#runwithpossync-2)
|
|
@@ -2994,7 +3423,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:147](https://github.com/isdk/ai-t
|
|
|
2994
3423
|
|
|
2995
3424
|
> `static` **seal**\<`T`\>(`o`): `T`
|
|
2996
3425
|
|
|
2997
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:216
|
|
3426
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:216
|
|
2998
3427
|
|
|
2999
3428
|
Prevents the modification of attributes of existing properties, and prevents the addition of new properties.
|
|
3000
3429
|
|
|
@@ -3024,7 +3453,7 @@ Object on which to lock the attributes.
|
|
|
3024
3453
|
|
|
3025
3454
|
> `static` **setApiRoot**(`v`): `void`
|
|
3026
3455
|
|
|
3027
|
-
Defined in: [packages/ai-tool/src/server-tools.ts:
|
|
3456
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:61](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/server-tools.ts#L61)
|
|
3028
3457
|
|
|
3029
3458
|
#### Parameters
|
|
3030
3459
|
|
|
@@ -3046,7 +3475,7 @@ Defined in: [packages/ai-tool/src/server-tools.ts:30](https://github.com/isdk/ai
|
|
|
3046
3475
|
|
|
3047
3476
|
> `static` **setPrototypeOf**(`o`, `proto`): `any`
|
|
3048
3477
|
|
|
3049
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:339
|
|
3478
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:339
|
|
3050
3479
|
|
|
3051
3480
|
Sets the prototype of a specified object o to object proto or null. Returns the object o.
|
|
3052
3481
|
|
|
@@ -3074,11 +3503,29 @@ The value of the new prototype or null.
|
|
|
3074
3503
|
|
|
3075
3504
|
***
|
|
3076
3505
|
|
|
3506
|
+
### setPubSubTransport()
|
|
3507
|
+
|
|
3508
|
+
> `static` **setPubSubTransport**(`t`?): `void`
|
|
3509
|
+
|
|
3510
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-server.ts:24](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/funcs/event-server.ts#L24)
|
|
3511
|
+
|
|
3512
|
+
#### Parameters
|
|
3513
|
+
|
|
3514
|
+
##### t?
|
|
3515
|
+
|
|
3516
|
+
[`IPubSubServerTransport`](../interfaces/IPubSubServerTransport.md)
|
|
3517
|
+
|
|
3518
|
+
#### Returns
|
|
3519
|
+
|
|
3520
|
+
`void`
|
|
3521
|
+
|
|
3522
|
+
***
|
|
3523
|
+
|
|
3077
3524
|
### subscribe()
|
|
3078
3525
|
|
|
3079
|
-
> `static` **subscribe**(`req`, `res`, `events`?): `
|
|
3526
|
+
> `static` **subscribe**(`req`, `res`, `events`?, `options`?): `undefined` \| [`PubSubClient`](../interfaces/PubSubClient.md)
|
|
3080
3527
|
|
|
3081
|
-
Defined in: [packages/ai-tool/src/funcs/event-server.ts:
|
|
3528
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-server.ts:54](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/funcs/event-server.ts#L54)
|
|
3082
3529
|
|
|
3083
3530
|
#### Parameters
|
|
3084
3531
|
|
|
@@ -3094,21 +3541,13 @@ Defined in: [packages/ai-tool/src/funcs/event-server.ts:46](https://github.com/i
|
|
|
3094
3541
|
|
|
3095
3542
|
`string`[]
|
|
3096
3543
|
|
|
3097
|
-
|
|
3098
|
-
|
|
3099
|
-
`object`
|
|
3100
|
-
|
|
3101
|
-
##### events
|
|
3102
|
-
|
|
3103
|
-
> **events**: `undefined` \| `Events`
|
|
3104
|
-
|
|
3105
|
-
##### req
|
|
3544
|
+
##### options?
|
|
3106
3545
|
|
|
3107
|
-
|
|
3546
|
+
`any`
|
|
3108
3547
|
|
|
3109
|
-
|
|
3548
|
+
#### Returns
|
|
3110
3549
|
|
|
3111
|
-
|
|
3550
|
+
`undefined` \| [`PubSubClient`](../interfaces/PubSubClient.md)
|
|
3112
3551
|
|
|
3113
3552
|
***
|
|
3114
3553
|
|
|
@@ -3116,12 +3555,20 @@ Defined in: [packages/ai-tool/src/funcs/event-server.ts:46](https://github.com/i
|
|
|
3116
3555
|
|
|
3117
3556
|
> `static` **toJSON**(): `object`
|
|
3118
3557
|
|
|
3119
|
-
Defined in: [packages/ai-tool/src/server-tools.ts:
|
|
3558
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:74](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/server-tools.ts#L74)
|
|
3559
|
+
|
|
3560
|
+
Serializes all registered `ServerTools` instances into a JSON object.
|
|
3561
|
+
This method is typically called by a transport's discovery endpoint.
|
|
3562
|
+
|
|
3563
|
+
It filters for tools that are instances of `ServerTools` or marked as `isApi`.
|
|
3564
|
+
It omits the `func` body from the output unless `allowExportFunc` is true.
|
|
3120
3565
|
|
|
3121
3566
|
#### Returns
|
|
3122
3567
|
|
|
3123
3568
|
`object`
|
|
3124
3569
|
|
|
3570
|
+
A map of serializable tool definitions.
|
|
3571
|
+
|
|
3125
3572
|
#### Inherited from
|
|
3126
3573
|
|
|
3127
3574
|
[`ResServerTools`](ResServerTools.md).[`toJSON`](ResServerTools.md#tojson-2)
|
|
@@ -3132,7 +3579,9 @@ Defined in: [packages/ai-tool/src/server-tools.ts:44](https://github.com/isdk/ai
|
|
|
3132
3579
|
|
|
3133
3580
|
> `static` **unregister**(`name`): `undefined` \| [`ToolFunc`](ToolFunc.md)
|
|
3134
3581
|
|
|
3135
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
3582
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:547](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L547)
|
|
3583
|
+
|
|
3584
|
+
Unregisters a function by its name, also removing any associated aliases.
|
|
3136
3585
|
|
|
3137
3586
|
#### Parameters
|
|
3138
3587
|
|
|
@@ -3140,10 +3589,14 @@ Defined in: [packages/ai-tool/src/tool-func.ts:207](https://github.com/isdk/ai-t
|
|
|
3140
3589
|
|
|
3141
3590
|
`string`
|
|
3142
3591
|
|
|
3592
|
+
The name of the function to unregister.
|
|
3593
|
+
|
|
3143
3594
|
#### Returns
|
|
3144
3595
|
|
|
3145
3596
|
`undefined` \| [`ToolFunc`](ToolFunc.md)
|
|
3146
3597
|
|
|
3598
|
+
The unregistered `ToolFunc` instance, or `undefined` if it was not found.
|
|
3599
|
+
|
|
3147
3600
|
#### Inherited from
|
|
3148
3601
|
|
|
3149
3602
|
[`ResServerTools`](ResServerTools.md).[`unregister`](ResServerTools.md#unregister-2)
|
|
@@ -3156,7 +3609,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:207](https://github.com/isdk/ai-t
|
|
|
3156
3609
|
|
|
3157
3610
|
> `static` **values**\<`T`\>(`o`): `T`[]
|
|
3158
3611
|
|
|
3159
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2017.object.d.ts:24
|
|
3612
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2017.object.d.ts:24
|
|
3160
3613
|
|
|
3161
3614
|
Returns an array of values of the enumerable own properties of an object
|
|
3162
3615
|
|
|
@@ -3184,7 +3637,7 @@ Object that contains the properties and methods. This can be an object that you
|
|
|
3184
3637
|
|
|
3185
3638
|
> `static` **values**(`o`): `any`[]
|
|
3186
3639
|
|
|
3187
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2017.object.d.ts:30
|
|
3640
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2017.object.d.ts:30
|
|
3188
3641
|
|
|
3189
3642
|
Returns an array of values of the enumerable own properties of an object
|
|
3190
3643
|
|