@liangjie559567/ultrapower 5.6.2 → 5.6.4
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/.claude-plugin/marketplace.json +2 -2
- package/.claude-plugin/plugin.json +1 -1
- package/.mcp.json +6 -2
- package/LICENSE +21 -21
- package/bridge/codex-server.cjs +12 -6
- package/bridge/gemini-server.cjs +10 -6
- package/bridge/gyoshu_bridge.py +846 -846
- package/bridge/mcp-server.cjs +19 -14
- package/dist/analytics/transcript-parser.d.ts.map +1 -1
- package/dist/analytics/transcript-parser.js +4 -1
- package/dist/analytics/transcript-parser.js.map +1 -1
- package/dist/audit/logger.d.ts +1 -0
- package/dist/audit/logger.d.ts.map +1 -1
- package/dist/audit/logger.js +20 -14
- package/dist/audit/logger.js.map +1 -1
- package/dist/features/state-manager/index.d.ts +12 -0
- package/dist/features/state-manager/index.d.ts.map +1 -1
- package/dist/features/state-manager/index.js +147 -0
- package/dist/features/state-manager/index.js.map +1 -1
- package/dist/hooks/comment-checker/index.d.ts.map +1 -1
- package/dist/hooks/comment-checker/index.js +3 -1
- package/dist/hooks/comment-checker/index.js.map +1 -1
- package/dist/hooks/empty-message-sanitizer/index.d.ts.map +1 -1
- package/dist/hooks/empty-message-sanitizer/index.js +3 -1
- package/dist/hooks/empty-message-sanitizer/index.js.map +1 -1
- package/dist/hooks/learner/auto-invoke.d.ts +5 -5
- package/dist/hooks/learner/auto-invoke.d.ts.map +1 -1
- package/dist/hooks/learner/auto-invoke.js +21 -12
- package/dist/hooks/learner/auto-invoke.js.map +1 -1
- package/dist/hooks/learner/queue-archiver.d.ts.map +1 -1
- package/dist/hooks/learner/queue-archiver.js +6 -6
- package/dist/hooks/learner/queue-archiver.js.map +1 -1
- package/dist/hooks/learner/reflection-archiver.js +4 -4
- package/dist/hooks/learner/reflection-archiver.js.map +1 -1
- package/dist/hooks/learner/reflection-cleanup.js +2 -2
- package/dist/hooks/learner/reflection-cleanup.js.map +1 -1
- package/dist/hooks/omc-orchestrator/audit.d.ts +3 -3
- package/dist/hooks/omc-orchestrator/audit.d.ts.map +1 -1
- package/dist/hooks/omc-orchestrator/audit.js +25 -20
- package/dist/hooks/omc-orchestrator/audit.js.map +1 -1
- package/dist/hooks/permission-handler/index.d.ts +1 -1
- package/dist/hooks/permission-handler/index.d.ts.map +1 -1
- package/dist/hooks/permission-handler/index.js +12 -4
- package/dist/hooks/permission-handler/index.js.map +1 -1
- package/dist/hooks/preemptive-compaction/index.d.ts.map +1 -1
- package/dist/hooks/preemptive-compaction/index.js +3 -1
- package/dist/hooks/preemptive-compaction/index.js.map +1 -1
- package/dist/hooks/recovery/context-window.d.ts.map +1 -1
- package/dist/hooks/recovery/context-window.js +3 -1
- package/dist/hooks/recovery/context-window.js.map +1 -1
- package/dist/hooks/session-end/index.d.ts +6 -6
- package/dist/hooks/session-end/index.d.ts.map +1 -1
- package/dist/hooks/session-end/index.js +94 -93
- package/dist/hooks/session-end/index.js.map +1 -1
- package/dist/lib/path-validator.js +3 -3
- package/dist/lib/path-validator.js.map +1 -1
- package/dist/mcp/adapters/memory-adapter.d.ts +2 -2
- package/dist/mcp/adapters/state-adapter.d.ts +6 -6
- package/dist/mcp/adapters/trace-adapter.d.ts +2 -2
- package/dist/mcp/cli-detection.d.ts +5 -0
- package/dist/mcp/cli-detection.d.ts.map +1 -1
- package/dist/mcp/cli-detection.js +13 -4
- package/dist/mcp/cli-detection.js.map +1 -1
- package/dist/mcp/codex-core.d.ts.map +1 -1
- package/dist/mcp/codex-core.js +7 -5
- package/dist/mcp/codex-core.js.map +1 -1
- package/dist/mcp/config/schema.d.ts +3 -3
- package/dist/mcp/config-schema.d.ts +3 -3
- package/dist/mcp/gemini-core.js +5 -5
- package/dist/mcp/gemini-core.js.map +1 -1
- package/dist/monitoring/dashboard.d.ts +3 -3
- package/dist/monitoring/dashboard.d.ts.map +1 -1
- package/dist/monitoring/dashboard.js +16 -16
- package/dist/monitoring/dashboard.js.map +1 -1
- package/dist/monitoring/metrics-collector.d.ts +6 -6
- package/dist/monitoring/metrics-collector.d.ts.map +1 -1
- package/dist/monitoring/metrics-collector.js +62 -27
- package/dist/monitoring/metrics-collector.js.map +1 -1
- package/docs/CLAUDE.md +1 -1
- package/docs/api/assets/highlight.css +85 -85
- package/docs/api/assets/style.css +1633 -1633
- package/docs/api/classes/ContextCollector.html +21 -21
- package/docs/api/functions/activateUltrawork.html +2 -2
- package/docs/api/functions/addCustomNote.html +5 -5
- package/docs/api/functions/addDirective.html +2 -2
- package/docs/api/functions/addManualEntry.html +2 -2
- package/docs/api/functions/addPattern.html +3 -3
- package/docs/api/functions/addWorker.html +2 -2
- package/docs/api/functions/addWorkingMemoryEntry.html +2 -2
- package/docs/api/functions/analyzeContextUsage.html +2 -2
- package/docs/api/functions/appendProgress.html +2 -2
- package/docs/api/functions/appendSessionId.html +2 -2
- package/docs/api/functions/applyCommentFilters.html +3 -3
- package/docs/api/functions/assignFileToWorker.html +2 -2
- package/docs/api/functions/backgroundUpdateCheck.html +2 -2
- package/docs/api/functions/buildAxiomBootContext.html +1 -1
- package/docs/api/functions/buildBoulderContinuation.html +2 -2
- package/docs/api/functions/buildDelegationTable.html +2 -2
- package/docs/api/functions/buildKeyTriggersSection.html +2 -2
- package/docs/api/functions/buildOrchestratorReminder.html +2 -2
- package/docs/api/functions/buildUseAvoidSection.html +2 -2
- package/docs/api/functions/buildVerificationReminder.html +2 -2
- package/docs/api/functions/canResumeAutopilot.html +10 -10
- package/docs/api/functions/canStartMode.html +5 -5
- package/docs/api/functions/cancelAutopilot.html +3 -3
- package/docs/api/functions/cancelUltraQA.html +2 -2
- package/docs/api/functions/checkBackgroundNotifications.html +2 -2
- package/docs/api/functions/checkBoulderContinuation.html +2 -2
- package/docs/api/functions/checkDuplicateTriggers.html +2 -2
- package/docs/api/functions/checkExpertGate.html +1 -1
- package/docs/api/functions/checkForComments.html +2 -2
- package/docs/api/functions/checkForUpdates.html +2 -2
- package/docs/api/functions/checkIncompleteTodos.html +13 -13
- package/docs/api/functions/checkPersistentModes.html +3 -3
- package/docs/api/functions/cleanupOrphanedState.html +2 -2
- package/docs/api/functions/cleanupStaleAgents.html +2 -2
- package/docs/api/functions/cleanupTransientState.html +2 -2
- package/docs/api/functions/clearAgentUsageState.html +1 -1
- package/docs/api/functions/clearAllModeStates.html +2 -2
- package/docs/api/functions/clearAutopilot.html +2 -2
- package/docs/api/functions/clearAutopilotState.html +2 -2
- package/docs/api/functions/clearBeadsContext.html +2 -2
- package/docs/api/functions/clearBoulderState.html +2 -2
- package/docs/api/functions/clearDetectionState.html +2 -2
- package/docs/api/functions/clearInjectedPaths.html +2 -2
- package/docs/api/functions/clearInjectedRules.html +2 -2
- package/docs/api/functions/clearLinkedUltraworkState.html +2 -2
- package/docs/api/functions/clearModeState.html +10 -10
- package/docs/api/functions/clearProjectMemorySession.html +4 -4
- package/docs/api/functions/clearRalphState.html +2 -2
- package/docs/api/functions/clearRapidFireDebounce.html +2 -2
- package/docs/api/functions/clearSkillSession.html +2 -2
- package/docs/api/functions/clearThinkModeState.html +2 -2
- package/docs/api/functions/clearTrackingState.html +2 -2
- package/docs/api/functions/clearUltraQAState.html +2 -2
- package/docs/api/functions/clearVerificationState.html +3 -3
- package/docs/api/functions/commandExists.html +2 -2
- package/docs/api/functions/compareVersions.html +3 -3
- package/docs/api/functions/completeUltraQA.html +2 -2
- package/docs/api/functions/completeUltrapilot.html +2 -2
- package/docs/api/functions/completeWorker.html +2 -2
- package/docs/api/functions/containsTokenLimitError.html +2 -2
- package/docs/api/functions/createAgentToolRestrictions.html +3 -3
- package/docs/api/functions/createAgentUsageReminderHook.html +1 -1
- package/docs/api/functions/createAutoSlashCommandHook.html +7 -7
- package/docs/api/functions/createBackgroundNotificationHook.html +7 -7
- package/docs/api/functions/createBackgroundTaskManager.html +2 -2
- package/docs/api/functions/createBoulderState.html +2 -2
- package/docs/api/functions/createCommentCheckerHook.html +6 -6
- package/docs/api/functions/createCompactCheckpoint.html +2 -2
- package/docs/api/functions/createContentHash.html +2 -2
- package/docs/api/functions/createContextInjectorHook.html +7 -7
- package/docs/api/functions/createDirectoryReadmeInjectorHook.html +9 -9
- package/docs/api/functions/createEmptyMessageSanitizerHook.html +6 -6
- package/docs/api/functions/createEnvContext.html +2 -2
- package/docs/api/functions/createHookOutput.html +4 -4
- package/docs/api/functions/createLearnedSkillsHook.html +6 -6
- package/docs/api/functions/createMagicKeywordProcessor.html +2 -2
- package/docs/api/functions/createModeMarker.html +6 -6
- package/docs/api/functions/createPrd.html +2 -2
- package/docs/api/functions/createPreemptiveCompactionHook.html +6 -6
- package/docs/api/functions/createRalphLoopHook.html +2 -2
- package/docs/api/functions/createRecoveryHook.html +7 -7
- package/docs/api/functions/createRulesInjectorHook.html +8 -8
- package/docs/api/functions/createSimplePrd.html +2 -2
- package/docs/api/functions/createSisyphusOrchestratorHook.html +7 -7
- package/docs/api/functions/createSisyphusSession.html +7 -7
- package/docs/api/functions/createThinkModeHook.html +7 -7
- package/docs/api/functions/createThinkingBlockValidatorHook.html +1 -1
- package/docs/api/functions/createTodoContinuationHook.html +2 -2
- package/docs/api/functions/createUltraworkStateHook.html +2 -2
- package/docs/api/functions/deactivateUltrawork.html +8 -8
- package/docs/api/functions/decayHotPaths.html +2 -2
- package/docs/api/functions/decomposeTask.html +11 -11
- package/docs/api/functions/deepMerge.html +2 -2
- package/docs/api/functions/detectArchitectApproval.html +2 -2
- package/docs/api/functions/detectArchitectRejection.html +2 -2
- package/docs/api/functions/detectContextLimitError.html +2 -2
- package/docs/api/functions/detectContextLimitErrorInText.html +2 -2
- package/docs/api/functions/detectDirectivesFromMessage.html +2 -2
- package/docs/api/functions/detectEditError.html +2 -2
- package/docs/api/functions/detectEditErrorInOutput.html +2 -2
- package/docs/api/functions/detectEditErrorInText.html +2 -2
- package/docs/api/functions/detectExtractableMoment.html +2 -2
- package/docs/api/functions/detectKeywordsWithType.html +11 -11
- package/docs/api/functions/detectMagicKeywords.html +2 -2
- package/docs/api/functions/detectProjectEnvironment.html +2 -2
- package/docs/api/functions/detectRecoverableError.html +3 -3
- package/docs/api/functions/detectSessionErrorType.html +2 -2
- package/docs/api/functions/detectSlashCommand.html +3 -3
- package/docs/api/functions/detectThinkKeyword.html +2 -2
- package/docs/api/functions/detectUltrathinkKeyword.html +2 -2
- package/docs/api/functions/discoverAllCommands.html +2 -2
- package/docs/api/functions/enablePrdMode.html +2 -2
- package/docs/api/functions/enhancePrompt.html +2 -2
- package/docs/api/functions/ensureAutopilotDir.html +2 -2
- package/docs/api/functions/ensureDirectoryStructure.html +2 -2
- package/docs/api/functions/ensureModeStateDir.html +2 -2
- package/docs/api/functions/ensureSkillsDir.html +2 -2
- package/docs/api/functions/estimateTokens.html +2 -2
- package/docs/api/functions/executeSlashCommand.html +2 -2
- package/docs/api/functions/expandCommand.html +8 -8
- package/docs/api/functions/expandCommandPrompt.html +6 -6
- package/docs/api/functions/expandCommands.html +2 -2
- package/docs/api/functions/exportSessionSummary.html +2 -2
- package/docs/api/functions/exportWisdomToNotepad.html +2 -2
- package/docs/api/functions/extractPromptText.html +11 -11
- package/docs/api/functions/extractSlashPromptText.html +2 -2
- package/docs/api/functions/extractThinkPromptText.html +2 -2
- package/docs/api/functions/failWorker.html +2 -2
- package/docs/api/functions/findCommand.html +2 -2
- package/docs/api/functions/findMatchingSkills.html +2 -2
- package/docs/api/functions/findPlannerPlans.html +3 -3
- package/docs/api/functions/findPrdPath.html +2 -2
- package/docs/api/functions/findPreviousThinkingContent.html +1 -1
- package/docs/api/functions/findProgressPath.html +2 -2
- package/docs/api/functions/findProjectRoot.html +3 -3
- package/docs/api/functions/findRecoveryEmptyMessages.html +2 -2
- package/docs/api/functions/findRecoveryOrphanThinking.html +2 -2
- package/docs/api/functions/findRecoveryThinkingBlocks.html +2 -2
- package/docs/api/functions/findRuleFiles.html +4 -4
- package/docs/api/functions/findSkillFiles.html +3 -3
- package/docs/api/functions/formatCancelMessage.html +2 -2
- package/docs/api/functions/formatCompactSummary.html +2 -2
- package/docs/api/functions/formatContextSummary.html +3 -3
- package/docs/api/functions/formatDirectivesForContext.html +2 -2
- package/docs/api/functions/formatFailureSummary.html +2 -2
- package/docs/api/functions/formatFile.html +2 -2
- package/docs/api/functions/formatFileChanges.html +2 -2
- package/docs/api/functions/formatFileList.html +2 -2
- package/docs/api/functions/formatFullContext.html +2 -2
- package/docs/api/functions/formatFullNotepad.html +2 -2
- package/docs/api/functions/formatLearningsForContext.html +2 -2
- package/docs/api/functions/formatNextStoryPrompt.html +2 -2
- package/docs/api/functions/formatNotepadContext.html +2 -2
- package/docs/api/functions/formatPatternsForContext.html +2 -2
- package/docs/api/functions/formatPrd.html +2 -2
- package/docs/api/functions/formatPrdStatus.html +2 -2
- package/docs/api/functions/formatPreCompactSummary.html +2 -2
- package/docs/api/functions/formatProgressForContext.html +2 -2
- package/docs/api/functions/formatProgressMessage.html +2 -2
- package/docs/api/functions/formatStory.html +2 -2
- package/docs/api/functions/formatSummary.html +2 -2
- package/docs/api/functions/formatUpdateNotification.html +2 -2
- package/docs/api/functions/formatValidationResults.html +2 -2
- package/docs/api/functions/generateExtractionPrompt.html +2 -2
- package/docs/api/functions/generateSkillFrontmatter.html +2 -2
- package/docs/api/functions/generateSummary.html +2 -2
- package/docs/api/functions/getActiveAgentCount.html +2 -2
- package/docs/api/functions/getActiveExclusiveMode.html +4 -4
- package/docs/api/functions/getActiveModes.html +2 -2
- package/docs/api/functions/getActivePlanPath.html +2 -2
- package/docs/api/functions/getAgentDefinitions.html +2 -2
- package/docs/api/functions/getAgentsByType.html +2 -2
- package/docs/api/functions/getAllCommands.html +2 -2
- package/docs/api/functions/getAllModeStatuses.html +5 -5
- package/docs/api/functions/getAllSkills.html +2 -2
- package/docs/api/functions/getArchitectRejectionContinuationPrompt.html +2 -2
- package/docs/api/functions/getArchitectVerificationPrompt.html +2 -2
- package/docs/api/functions/getAutoFormatMessage.html +2 -2
- package/docs/api/functions/getAutopilotStateAge.html +3 -3
- package/docs/api/functions/getAvailableAgents.html +2 -2
- package/docs/api/functions/getAxiomDir.html +1 -1
- package/docs/api/functions/getBackgroundTaskGuidance.html +4 -4
- package/docs/api/functions/getBeadsContextConfig.html +2 -2
- package/docs/api/functions/getBeadsInstructions.html +2 -2
- package/docs/api/functions/getBoulderFilePath.html +2 -2
- package/docs/api/functions/getCheckpointPath.html +2 -2
- package/docs/api/functions/getClaudeThinkingConfig.html +3 -3
- package/docs/api/functions/getCommand.html +2 -2
- package/docs/api/functions/getCommandsDir.html +2 -2
- package/docs/api/functions/getCompactionQueueDepth.html +3 -3
- package/docs/api/functions/getCompletedWorkers.html +2 -2
- package/docs/api/functions/getDefaultMcpServers.html +1 -1
- package/docs/api/functions/getDefaultModelForCategory.html +2 -2
- package/docs/api/functions/getDetectionStats.html +2 -2
- package/docs/api/functions/getDirectPlanningPrompt.html +3 -3
- package/docs/api/functions/getExecutionPrompt.html +2 -2
- package/docs/api/functions/getExpansionPrompt.html +3 -3
- package/docs/api/functions/getExpertGateMessage.html +1 -1
- package/docs/api/functions/getFailedWorkers.html +2 -2
- package/docs/api/functions/getFormatter.html +2 -2
- package/docs/api/functions/getGitDiffStats.html +2 -2
- package/docs/api/functions/getGlobalStateFilePath.html +4 -4
- package/docs/api/functions/getGoalCommand.html +2 -2
- package/docs/api/functions/getHighVariant.html +3 -3
- package/docs/api/functions/getInstallInfo.html +2 -2
- package/docs/api/functions/getInstalledVersion.html +2 -2
- package/docs/api/functions/getIssuesToFix.html +2 -2
- package/docs/api/functions/getLastDetection.html +2 -2
- package/docs/api/functions/getLearnerConfigValue.html +2 -2
- package/docs/api/functions/getLinter.html +2 -2
- package/docs/api/functions/getManualSection.html +2 -2
- package/docs/api/functions/getMemoryFilePaths.html +1 -1
- package/docs/api/functions/getModeMarkerFilePath.html +2 -2
- package/docs/api/functions/getModeStateFilePath.html +2 -2
- package/docs/api/functions/getNextStory.html +2 -2
- package/docs/api/functions/getNotepadPath.html +2 -2
- package/docs/api/functions/getNotepadStats.html +2 -2
- package/docs/api/functions/getOmcPrdPath.html +2 -2
- package/docs/api/functions/getOmcProgressPath.html +2 -2
- package/docs/api/functions/getOmcSystemPrompt.html +2 -2
- package/docs/api/functions/getOmcToolNames.html +3 -3
- package/docs/api/functions/getPatterns.html +2 -2
- package/docs/api/functions/getPhasePrompt.html +2 -2
- package/docs/api/functions/getPlanName.html +2 -2
- package/docs/api/functions/getPlanPath.html +2 -2
- package/docs/api/functions/getPlanProgress.html +2 -2
- package/docs/api/functions/getPlanSummaries.html +2 -2
- package/docs/api/functions/getPrdCompletionStatus.html +2 -2
- package/docs/api/functions/getPrdPath.html +2 -2
- package/docs/api/functions/getPrdStatus.html +2 -2
- package/docs/api/functions/getPreCommitReminderMessage.html +2 -2
- package/docs/api/functions/getPriorityContext.html +2 -2
- package/docs/api/functions/getProgressContext.html +2 -2
- package/docs/api/functions/getProgressPath.html +2 -2
- package/docs/api/functions/getPromotionCandidates.html +2 -2
- package/docs/api/functions/getQAPrompt.html +2 -2
- package/docs/api/functions/getRalphContext.html +3 -3
- package/docs/api/functions/getReadmesForPath.html +2 -2
- package/docs/api/functions/getRecentLearnings.html +2 -2
- package/docs/api/functions/getRulesForPath.html +2 -2
- package/docs/api/functions/getRunningAgents.html +2 -2
- package/docs/api/functions/getRunningWorkers.html +2 -2
- package/docs/api/functions/getSessionTokenEstimate.html +2 -2
- package/docs/api/functions/getSkillsDir.html +2 -2
- package/docs/api/functions/getSpecPath.html +2 -2
- package/docs/api/functions/getStaleAgents.html +2 -2
- package/docs/api/functions/getStateDir.html +2 -2
- package/docs/api/functions/getStory.html +2 -2
- package/docs/api/functions/getSubagentStateFilePath.html +2 -2
- package/docs/api/functions/getThinkModeState.html +2 -2
- package/docs/api/functions/getThinkingConfig.html +3 -3
- package/docs/api/functions/getTopHotPaths.html +2 -2
- package/docs/api/functions/getTrackingStats.html +2 -2
- package/docs/api/functions/getTransitionPrompt.html +2 -2
- package/docs/api/functions/getUltraworkPersistenceMessage.html +2 -2
- package/docs/api/functions/getValidationPrompt.html +2 -2
- package/docs/api/functions/getValidationSpawnPrompt.html +2 -2
- package/docs/api/functions/getValidationStats.html +1 -1
- package/docs/api/functions/getValidationStatus.html +2 -2
- package/docs/api/functions/getWorkingMemory.html +2 -2
- package/docs/api/functions/handleBackgroundEvent.html +3 -3
- package/docs/api/functions/handleContextWindowRecovery.html +2 -2
- package/docs/api/functions/handleEditErrorRecovery.html +2 -2
- package/docs/api/functions/handlePermissionRequest.html +2 -2
- package/docs/api/functions/handleRecovery.html +10 -10
- package/docs/api/functions/handleSessionEnd.html +2 -2
- package/docs/api/functions/handleSessionRecovery.html +2 -2
- package/docs/api/functions/handleSharedFiles.html +7 -7
- package/docs/api/functions/handleSubagentStart.html +2 -2
- package/docs/api/functions/handleSubagentStop.html +2 -2
- package/docs/api/functions/hasBoulder.html +2 -2
- package/docs/api/functions/hasContentParts.html +1 -1
- package/docs/api/functions/hasModeState.html +3 -3
- package/docs/api/functions/hasPrd.html +2 -2
- package/docs/api/functions/hasTextContent.html +2 -2
- package/docs/api/functions/hasValidContent.html +3 -3
- package/docs/api/functions/incrementAgentCount.html +2 -2
- package/docs/api/functions/incrementRalphIteration.html +2 -2
- package/docs/api/functions/incrementReinforcement.html +2 -2
- package/docs/api/functions/initAutopilot.html +2 -2
- package/docs/api/functions/initNotepad.html +2 -2
- package/docs/api/functions/initPrd.html +2 -2
- package/docs/api/functions/initProgress.html +2 -2
- package/docs/api/functions/initUltrapilot.html +2 -2
- package/docs/api/functions/injectContextIntoText.html +2 -2
- package/docs/api/functions/injectPendingContext.html +3 -3
- package/docs/api/functions/injectRecoveryTextPart.html +2 -2
- package/docs/api/functions/install.html +2 -2
- package/docs/api/functions/integrateResults.html +5 -5
- package/docs/api/functions/isActiveModeRunning.html +2 -2
- package/docs/api/functions/isAllowedPath.html +2 -2
- package/docs/api/functions/isAlreadyHighVariant.html +2 -2
- package/docs/api/functions/isAutopilotActive.html +2 -2
- package/docs/api/functions/isAxiomEnabled.html +1 -1
- package/docs/api/functions/isClaudeInstalled.html +3 -3
- package/docs/api/functions/isClaudeModel.html +2 -2
- package/docs/api/functions/isCompactionInProgress.html +3 -3
- package/docs/api/functions/isDuplicateByContentHash.html +2 -2
- package/docs/api/functions/isDuplicateByRealPath.html +2 -2
- package/docs/api/functions/isExcludedCommand.html +2 -2
- package/docs/api/functions/isExtendedThinkingModel.html +1 -1
- package/docs/api/functions/isFileOwnedByWorker.html +2 -2
- package/docs/api/functions/isFormatterAvailable.html +2 -2
- package/docs/api/functions/isGptModel.html +2 -2
- package/docs/api/functions/isInstalled.html +2 -2
- package/docs/api/functions/isLearnerEnabled.html +2 -2
- package/docs/api/functions/isModeActive.html +6 -6
- package/docs/api/functions/isNonInteractive.html +1 -1
- package/docs/api/functions/isRecoverableError.html +2 -2
- package/docs/api/functions/isSafeCommand.html +2 -2
- package/docs/api/functions/isSessionRecoverable.html +2 -2
- package/docs/api/functions/isSharedFile.html +2 -2
- package/docs/api/functions/isThinkModeActive.html +2 -2
- package/docs/api/functions/isToolPart.html +2 -2
- package/docs/api/functions/isUltraQAActive.html +1 -1
- package/docs/api/functions/isWriteEditTool.html +2 -2
- package/docs/api/functions/learnFromToolOutput.html +7 -7
- package/docs/api/functions/lintFile.html +2 -2
- package/docs/api/functions/listAvailableCommands.html +2 -2
- package/docs/api/functions/listCommands.html +2 -2
- package/docs/api/functions/listPromotableLearnings.html +2 -2
- package/docs/api/functions/loadAgentPrompt.html +7 -7
- package/docs/api/functions/loadAgentUsageState.html +1 -1
- package/docs/api/functions/loadAllSkills.html +3 -3
- package/docs/api/functions/loadConfig.html +2 -2
- package/docs/api/functions/loadInjectedPaths.html +2 -2
- package/docs/api/functions/loadInjectedRules.html +2 -2
- package/docs/api/functions/loadLearnerConfig.html +2 -2
- package/docs/api/functions/loadProjectMemory.html +3 -3
- package/docs/api/functions/loadSkillById.html +2 -2
- package/docs/api/functions/mapDirectoryStructure.html +2 -2
- package/docs/api/functions/markStoryComplete.html +2 -2
- package/docs/api/functions/markStoryIncomplete.html +2 -2
- package/docs/api/functions/mergeAgentConfig.html +2 -2
- package/docs/api/functions/parseAxiomState.html +1 -1
- package/docs/api/functions/parseContextLimitError.html +2 -2
- package/docs/api/functions/parseProgress.html +2 -2
- package/docs/api/functions/parseRuleFrontmatter.html +10 -10
- package/docs/api/functions/parseSkillFile.html +2 -2
- package/docs/api/functions/parseSlashCommand.html +2 -2
- package/docs/api/functions/parseTokenLimitError.html +2 -2
- package/docs/api/functions/performUpdate.html +2 -2
- package/docs/api/functions/prependRecoveryThinkingPart.html +2 -2
- package/docs/api/functions/prependThinkingBlock.html +1 -1
- package/docs/api/functions/processAxiomBoot.html +1 -1
- package/docs/api/functions/processAxiomGuards.html +1 -1
- package/docs/api/functions/processBackgroundNotification.html +2 -2
- package/docs/api/functions/processBackgroundNotificationHook.html +2 -2
- package/docs/api/functions/processEditOutput.html +2 -2
- package/docs/api/functions/processHook.html +3 -3
- package/docs/api/functions/processMessageForSkills.html +2 -2
- package/docs/api/functions/processOrchestratorPostTool.html +3 -3
- package/docs/api/functions/processOrchestratorPreTool.html +3 -3
- package/docs/api/functions/processPermissionRequest.html +2 -2
- package/docs/api/functions/processPreCompact.html +6 -6
- package/docs/api/functions/processProjectMemoryPreCompact.html +3 -3
- package/docs/api/functions/processResponseForDetection.html +3 -3
- package/docs/api/functions/processSessionEnd.html +2 -2
- package/docs/api/functions/processSetup.html +2 -2
- package/docs/api/functions/processSetupInit.html +2 -2
- package/docs/api/functions/processSetupMaintenance.html +2 -2
- package/docs/api/functions/processSlashCommand.html +2 -2
- package/docs/api/functions/processSubagentStart.html +2 -2
- package/docs/api/functions/processSubagentStop.html +2 -2
- package/docs/api/functions/processThinkMode.html +3 -3
- package/docs/api/functions/promoteLearning.html +2 -2
- package/docs/api/functions/pruneOldEntries.html +2 -2
- package/docs/api/functions/pruneOldStateFiles.html +2 -2
- package/docs/api/functions/readActiveContext.html +1 -1
- package/docs/api/functions/readAutopilotState.html +2 -2
- package/docs/api/functions/readBoulderState.html +2 -2
- package/docs/api/functions/readModeMarker.html +4 -4
- package/docs/api/functions/readNotepad.html +2 -2
- package/docs/api/functions/readPrd.html +2 -2
- package/docs/api/functions/readProgress.html +2 -2
- package/docs/api/functions/readProgressRaw.html +2 -2
- package/docs/api/functions/readProjectDecisions.html +1 -1
- package/docs/api/functions/readRalphState.html +2 -2
- package/docs/api/functions/readRecoveryMessages.html +2 -2
- package/docs/api/functions/readRecoveryParts.html +2 -2
- package/docs/api/functions/readTrackingState.html +3 -3
- package/docs/api/functions/readUltraQAState.html +2 -2
- package/docs/api/functions/readUltrapilotState.html +2 -2
- package/docs/api/functions/readUltraworkState.html +4 -4
- package/docs/api/functions/readUserPreferences.html +1 -1
- package/docs/api/functions/readVerificationState.html +3 -3
- package/docs/api/functions/recordArchitectFeedback.html +2 -2
- package/docs/api/functions/recordConflict.html +2 -2
- package/docs/api/functions/recordFailure.html +2 -2
- package/docs/api/functions/recordHookFire.html +2 -2
- package/docs/api/functions/recordHookResult.html +2 -2
- package/docs/api/functions/recordKeywordDetected.html +2 -2
- package/docs/api/functions/recordModeChange.html +2 -2
- package/docs/api/functions/recordPattern.html +2 -2
- package/docs/api/functions/recordSessionMetrics.html +2 -2
- package/docs/api/functions/recordSkillActivated.html +2 -2
- package/docs/api/functions/recordSkillInvoked.html +2 -2
- package/docs/api/functions/recordStoryProgress.html +2 -2
- package/docs/api/functions/recordValidationVerdict.html +2 -2
- package/docs/api/functions/registerBeadsContext.html +3 -3
- package/docs/api/functions/registerProjectMemoryContext.html +6 -6
- package/docs/api/functions/removeCodeBlocks.html +12 -12
- package/docs/api/functions/removeModeMarker.html +5 -5
- package/docs/api/functions/removeSlashCodeBlocks.html +2 -2
- package/docs/api/functions/removeThinkCodeBlocks.html +2 -2
- package/docs/api/functions/replaceRecoveryEmptyTextParts.html +2 -2
- package/docs/api/functions/rescanProjectEnvironment.html +4 -4
- package/docs/api/functions/resetSessionTokenEstimate.html +2 -2
- package/docs/api/functions/resumeAutopilot.html +2 -2
- package/docs/api/functions/runPreCommitChecks.html +2 -2
- package/docs/api/functions/runTests.html +2 -2
- package/docs/api/functions/runTypeCheck.html +2 -2
- package/docs/api/functions/sanitizeMessage.html +2 -2
- package/docs/api/functions/sanitizeMessages.html +2 -2
- package/docs/api/functions/saveAgentUsageState.html +1 -1
- package/docs/api/functions/saveInjectedPaths.html +2 -2
- package/docs/api/functions/saveInjectedRules.html +2 -2
- package/docs/api/functions/saveLearnerConfig.html +2 -2
- package/docs/api/functions/saveModeSummary.html +2 -2
- package/docs/api/functions/saveProjectMemory.html +3 -3
- package/docs/api/functions/saveVersionMetadata.html +2 -2
- package/docs/api/functions/setCurrentStory.html +2 -2
- package/docs/api/functions/setEnvironmentVariables.html +2 -2
- package/docs/api/functions/setLearnerConfigValue.html +2 -2
- package/docs/api/functions/setPriorityContext.html +2 -2
- package/docs/api/functions/shouldActivateThinkMode.html +3 -3
- package/docs/api/functions/shouldActivateUltrathink.html +2 -2
- package/docs/api/functions/shouldApplyRule.html +2 -2
- package/docs/api/functions/shouldCheckForUpdates.html +2 -2
- package/docs/api/functions/shouldCompleteByPrd.html +2 -2
- package/docs/api/functions/shouldPromptExtraction.html +2 -2
- package/docs/api/functions/shouldReinforceUltrawork.html +2 -2
- package/docs/api/functions/shouldRetryValidation.html +2 -2
- package/docs/api/functions/shouldRunInBackground.html +8 -8
- package/docs/api/functions/spawnWorkers.html +7 -7
- package/docs/api/functions/startUltraQA.html +3 -3
- package/docs/api/functions/startUltrapilot.html +7 -7
- package/docs/api/functions/startValidationRound.html +2 -2
- package/docs/api/functions/startVerification.html +2 -2
- package/docs/api/functions/startsWithThinkingBlock.html +1 -1
- package/docs/api/functions/stopUltraQA.html +2 -2
- package/docs/api/functions/stripRecoveryThinkingParts.html +2 -2
- package/docs/api/functions/toSdkMcpFormat.html +2 -2
- package/docs/api/functions/trackAccess.html +2 -2
- package/docs/api/functions/trackProgress.html +5 -5
- package/docs/api/functions/transitionPhase.html +2 -2
- package/docs/api/functions/transitionRalphToUltraQA.html +9 -9
- package/docs/api/functions/transitionToComplete.html +2 -2
- package/docs/api/functions/transitionToFailed.html +2 -2
- package/docs/api/functions/transitionUltraQAToValidation.html +2 -2
- package/docs/api/functions/updateDirectoryAccess.html +2 -2
- package/docs/api/functions/updateExecution.html +2 -2
- package/docs/api/functions/updateExpansion.html +2 -2
- package/docs/api/functions/updatePlanning.html +2 -2
- package/docs/api/functions/updateQA.html +2 -2
- package/docs/api/functions/updateValidation.html +2 -2
- package/docs/api/functions/updateWorkerState.html +2 -2
- package/docs/api/functions/validateAgentConfig.html +2 -2
- package/docs/api/functions/validateCommitMessage.html +2 -2
- package/docs/api/functions/validateConfigFiles.html +2 -2
- package/docs/api/functions/validateExtractionRequest.html +2 -2
- package/docs/api/functions/validateMessage.html +1 -1
- package/docs/api/functions/validateMessages.html +1 -1
- package/docs/api/functions/validateSkillMetadata.html +2 -2
- package/docs/api/functions/writeAutopilotState.html +2 -2
- package/docs/api/functions/writeBoulderState.html +2 -2
- package/docs/api/functions/writePrd.html +2 -2
- package/docs/api/functions/writeRalphState.html +2 -2
- package/docs/api/functions/writeSkill.html +2 -2
- package/docs/api/functions/writeTrackingState.html +5 -5
- package/docs/api/functions/writeUltraQAState.html +2 -2
- package/docs/api/functions/writeUltrapilotState.html +2 -2
- package/docs/api/functions/writeUltraworkState.html +2 -2
- package/docs/api/functions/writeVerificationState.html +2 -2
- package/docs/api/hierarchy.html +1 -1
- package/docs/api/index.html +843 -843
- package/docs/api/interfaces/AgentConfig.html +18 -18
- package/docs/api/interfaces/AgentOverrideConfig.html +10 -10
- package/docs/api/interfaces/AgentPromptMetadata.html +19 -19
- package/docs/api/interfaces/AgentState.html +5 -5
- package/docs/api/interfaces/AgentUsageState.html +8 -8
- package/docs/api/interfaces/AutoSlashCommandHookInput.html +5 -5
- package/docs/api/interfaces/AutoSlashCommandHookOutput.html +3 -3
- package/docs/api/interfaces/AutoSlashCommandResult.html +5 -5
- package/docs/api/interfaces/AutopilotConfig.html +26 -26
- package/docs/api/interfaces/AutopilotExecution.html +16 -16
- package/docs/api/interfaces/AutopilotExpansion.html +12 -12
- package/docs/api/interfaces/AutopilotPlanning.html +8 -8
- package/docs/api/interfaces/AutopilotQA.html +12 -12
- package/docs/api/interfaces/AutopilotResult.html +10 -10
- package/docs/api/interfaces/AutopilotState.html +36 -36
- package/docs/api/interfaces/AutopilotSummary.html +16 -16
- package/docs/api/interfaces/AutopilotValidation.html +10 -10
- package/docs/api/interfaces/AutopilotValidationResult.html +8 -8
- package/docs/api/interfaces/AvailableAgent.html +5 -5
- package/docs/api/interfaces/AxiomBootInput.html +3 -3
- package/docs/api/interfaces/AxiomBootOutput.html +4 -4
- package/docs/api/interfaces/AxiomGuardsInput.html +4 -4
- package/docs/api/interfaces/AxiomGuardsOutput.html +4 -4
- package/docs/api/interfaces/AxiomMemoryFiles.html +5 -5
- package/docs/api/interfaces/AxiomState.html +8 -8
- package/docs/api/interfaces/BackgroundNotificationHookConfig.html +11 -11
- package/docs/api/interfaces/BackgroundNotificationHookInput.html +8 -8
- package/docs/api/interfaces/BackgroundNotificationHookOutput.html +8 -8
- package/docs/api/interfaces/BackgroundTask.html +7 -7
- package/docs/api/interfaces/BackgroundTaskManager.html +26 -26
- package/docs/api/interfaces/BeadsContextConfig.html +4 -4
- package/docs/api/interfaces/BoulderState.html +12 -12
- package/docs/api/interfaces/BuildInfo.html +6 -6
- package/docs/api/interfaces/CanStartResult.html +4 -4
- package/docs/api/interfaces/CancelResult.html +4 -4
- package/docs/api/interfaces/ClaudeThinkingConfig.html +4 -4
- package/docs/api/interfaces/CodeConventions.html +5 -5
- package/docs/api/interfaces/CodebasePattern.html +5 -5
- package/docs/api/interfaces/CommandInfo.html +5 -5
- package/docs/api/interfaces/CommandMetadata.html +7 -7
- package/docs/api/interfaces/CommentCheckResult.html +10 -10
- package/docs/api/interfaces/CommentCheckerConfig.html +6 -6
- package/docs/api/interfaces/CommentInfo.html +14 -14
- package/docs/api/interfaces/CommentPendingCall.html +18 -18
- package/docs/api/interfaces/CommitConfig.html +9 -9
- package/docs/api/interfaces/CompactCheckpoint.html +7 -7
- package/docs/api/interfaces/ContextEntry.html +14 -14
- package/docs/api/interfaces/ContextUsageResult.html +12 -12
- package/docs/api/interfaces/CustomNote.html +5 -5
- package/docs/api/interfaces/DelegationDecision.html +7 -7
- package/docs/api/interfaces/DelegationRoute.html +7 -7
- package/docs/api/interfaces/DelegationRoutingConfig.html +5 -5
- package/docs/api/interfaces/DelegationTrigger.html +6 -6
- package/docs/api/interfaces/DetectedKeyword.html +13 -13
- package/docs/api/interfaces/DetectionConfig.html +8 -8
- package/docs/api/interfaces/DetectionResult.html +13 -13
- package/docs/api/interfaces/DirectoryInfo.html +7 -7
- package/docs/api/interfaces/EmptyMessageSanitizerConfig.html +6 -6
- package/docs/api/interfaces/EmptyMessageSanitizerInput.html +6 -6
- package/docs/api/interfaces/EmptyMessageSanitizerOutput.html +8 -8
- package/docs/api/interfaces/ExecuteResult.html +5 -5
- package/docs/api/interfaces/ExpandedCommand.html +4 -4
- package/docs/api/interfaces/ExternalModelPreference.html +4 -4
- package/docs/api/interfaces/ExternalModelsConfig.html +6 -6
- package/docs/api/interfaces/ExternalModelsDefaults.html +5 -5
- package/docs/api/interfaces/ExternalModelsFallbackPolicy.html +5 -5
- package/docs/api/interfaces/FileOwnership.html +8 -8
- package/docs/api/interfaces/FormatConfig.html +7 -7
- package/docs/api/interfaces/FrameworkDetection.html +4 -4
- package/docs/api/interfaces/FullAgentConfig.html +26 -26
- package/docs/api/interfaces/GateCheckResult.html +5 -5
- package/docs/api/interfaces/GitBranchPattern.html +3 -3
- package/docs/api/interfaces/HookContext.html +5 -5
- package/docs/api/interfaces/HookDefinition.html +5 -5
- package/docs/api/interfaces/HookInput.html +18 -18
- package/docs/api/interfaces/HookOutput.html +10 -10
- package/docs/api/interfaces/HookResult.html +4 -4
- package/docs/api/interfaces/HotPath.html +6 -6
- package/docs/api/interfaces/InjectedPathsData.html +9 -9
- package/docs/api/interfaces/InjectedRulesData.html +10 -10
- package/docs/api/interfaces/InjectedSkillsData.html +8 -8
- package/docs/api/interfaces/InjectionResult.html +8 -8
- package/docs/api/interfaces/InstallOptions.html +9 -9
- package/docs/api/interfaces/InstallResult.html +10 -10
- package/docs/api/interfaces/IntegrationResult.html +14 -14
- package/docs/api/interfaces/LanguageDetection.html +5 -5
- package/docs/api/interfaces/LearnedSkill.html +16 -16
- package/docs/api/interfaces/LearnerConfig.html +18 -18
- package/docs/api/interfaces/LintConfig.html +7 -7
- package/docs/api/interfaces/MagicKeyword.html +4 -4
- package/docs/api/interfaces/MatchResult.html +6 -6
- package/docs/api/interfaces/MessageContext.html +8 -8
- package/docs/api/interfaces/MessageInfo.html +9 -9
- package/docs/api/interfaces/MessagePart.html +15 -15
- package/docs/api/interfaces/MessageWithModel.html +3 -3
- package/docs/api/interfaces/MessageWithParts.html +6 -6
- package/docs/api/interfaces/MessagesTransformHook.html +3 -3
- package/docs/api/interfaces/MessagesTransformInput.html +3 -3
- package/docs/api/interfaces/MessagesTransformOutput.html +3 -3
- package/docs/api/interfaces/ModeConfig.html +13 -13
- package/docs/api/interfaces/ModeStatus.html +4 -4
- package/docs/api/interfaces/ModelRef.html +4 -4
- package/docs/api/interfaces/NonInteractiveEnvConfig.html +2 -2
- package/docs/api/interfaces/NotepadConfig.html +7 -7
- package/docs/api/interfaces/NotepadStats.html +11 -11
- package/docs/api/interfaces/NotificationCheckResult.html +8 -8
- package/docs/api/interfaces/OrchestratorToolInput.html +6 -6
- package/docs/api/interfaces/OrchestratorToolOutput.html +6 -6
- package/docs/api/interfaces/OutputPart.html +4 -4
- package/docs/api/interfaces/PRD.html +9 -9
- package/docs/api/interfaces/PRDStatus.html +13 -13
- package/docs/api/interfaces/ParsedSlashCommand.html +8 -8
- package/docs/api/interfaces/ParsedTokenLimitError.html +16 -16
- package/docs/api/interfaces/PendingContext.html +8 -8
- package/docs/api/interfaces/PermissionHookOutput.html +4 -4
- package/docs/api/interfaces/PermissionRequestInput.html +9 -9
- package/docs/api/interfaces/PersistentModeResult.html +9 -9
- package/docs/api/interfaces/PlanProgress.html +8 -8
- package/docs/api/interfaces/PlanSummary.html +10 -10
- package/docs/api/interfaces/PluginConfig.html +17 -17
- package/docs/api/interfaces/PreCommitResult.html +3 -3
- package/docs/api/interfaces/PreCompactHookOutput.html +4 -4
- package/docs/api/interfaces/PreCompactInput.html +8 -8
- package/docs/api/interfaces/PreemptiveCompactionConfig.html +14 -14
- package/docs/api/interfaces/PriorityContextResult.html +5 -5
- package/docs/api/interfaces/ProgressEntry.html +11 -11
- package/docs/api/interfaces/ProgressLog.html +7 -7
- package/docs/api/interfaces/ProjectMemory.html +14 -14
- package/docs/api/interfaces/ProjectStructure.html +5 -5
- package/docs/api/interfaces/PromotionCandidate.html +9 -9
- package/docs/api/interfaces/PruneResult.html +5 -5
- package/docs/api/interfaces/QualityValidation.html +10 -10
- package/docs/api/interfaces/RalphLoopHook.html +4 -4
- package/docs/api/interfaces/RalphLoopOptions.html +5 -5
- package/docs/api/interfaces/RalphLoopState.html +21 -21
- package/docs/api/interfaces/RecoveryConfig.html +16 -16
- package/docs/api/interfaces/RecoveryMessageData.html +4 -4
- package/docs/api/interfaces/RecoveryResult.html +10 -10
- package/docs/api/interfaces/RecoveryStoredMessageMeta.html +8 -8
- package/docs/api/interfaces/RecoveryStoredReasoningPart.html +7 -7
- package/docs/api/interfaces/RecoveryStoredTextPart.html +9 -9
- package/docs/api/interfaces/RecoveryStoredToolPart.html +9 -9
- package/docs/api/interfaces/RegisterContextOptions.html +12 -12
- package/docs/api/interfaces/ReleaseInfo.html +9 -9
- package/docs/api/interfaces/ResolveDelegationOptions.html +7 -7
- package/docs/api/interfaces/ResolveOptions.html +6 -6
- package/docs/api/interfaces/ResolvedModel.html +5 -5
- package/docs/api/interfaces/RetryState.html +6 -6
- package/docs/api/interfaces/RuleFileCandidate.html +12 -12
- package/docs/api/interfaces/RuleFrontmatterResult.html +6 -6
- package/docs/api/interfaces/RuleInfo.html +18 -18
- package/docs/api/interfaces/RuleMetadata.html +9 -9
- package/docs/api/interfaces/RuleToInject.html +10 -10
- package/docs/api/interfaces/SessionEndHookOutput.html +2 -2
- package/docs/api/interfaces/SessionEndInput.html +9 -9
- package/docs/api/interfaces/SessionMetrics.html +9 -9
- package/docs/api/interfaces/SessionState.html +5 -5
- package/docs/api/interfaces/SetupHookOutput.html +3 -3
- package/docs/api/interfaces/SetupInput.html +7 -7
- package/docs/api/interfaces/SetupResult.html +5 -5
- package/docs/api/interfaces/ShellHook.html +4 -4
- package/docs/api/interfaces/SisyphusOptions.html +14 -14
- package/docs/api/interfaces/SisyphusSession.html +16 -16
- package/docs/api/interfaces/SkillExtractionRequest.html +12 -12
- package/docs/api/interfaces/SkillFileCandidate.html +10 -10
- package/docs/api/interfaces/SkillHookContext.html +5 -5
- package/docs/api/interfaces/SkillMetadata.html +22 -22
- package/docs/api/interfaces/SkillParseResult.html +5 -5
- package/docs/api/interfaces/SubagentHookOutput.html +3 -3
- package/docs/api/interfaces/SubagentInfo.html +14 -14
- package/docs/api/interfaces/SubagentStartInput.html +10 -10
- package/docs/api/interfaces/SubagentStopInput.html +11 -11
- package/docs/api/interfaces/SubagentTrackingState.html +6 -6
- package/docs/api/interfaces/TaskExecutionDecision.html +10 -10
- package/docs/api/interfaces/TechStack.html +5 -5
- package/docs/api/interfaces/ThinkModeInput.html +4 -4
- package/docs/api/interfaces/ThinkModeState.html +12 -12
- package/docs/api/interfaces/ThinkingValidatorMessageInfo.html +6 -6
- package/docs/api/interfaces/ThinkingValidatorMessagePart.html +9 -9
- package/docs/api/interfaces/ThinkingValidatorMessageWithParts.html +4 -4
- package/docs/api/interfaces/TodoContinuationHook.html +2 -2
- package/docs/api/interfaces/TransitionResult.html +4 -4
- package/docs/api/interfaces/TruncateState.html +6 -6
- package/docs/api/interfaces/UltraQAOptions.html +5 -5
- package/docs/api/interfaces/UltraQAResult.html +9 -9
- package/docs/api/interfaces/UltraQAState.html +19 -19
- package/docs/api/interfaces/UltrapilotConfig.html +14 -14
- package/docs/api/interfaces/UltrapilotState.html +26 -26
- package/docs/api/interfaces/UltraworkState.html +17 -17
- package/docs/api/interfaces/UpdateCheckResult.html +7 -7
- package/docs/api/interfaces/UpdateResult.html +7 -7
- package/docs/api/interfaces/UserDirective.html +7 -7
- package/docs/api/interfaces/UserStory.html +15 -15
- package/docs/api/interfaces/ValidationCoordinatorResult.html +6 -6
- package/docs/api/interfaces/ValidationResult.html +10 -10
- package/docs/api/interfaces/VerificationState.html +17 -17
- package/docs/api/interfaces/VersionMetadata.html +12 -12
- package/docs/api/interfaces/WorkerState.html +24 -24
- package/docs/api/interfaces/WriteSkillResult.html +6 -6
- package/docs/api/modules.html +1 -1
- package/docs/api/types/AgentCategory.html +2 -2
- package/docs/api/types/AgentCost.html +3 -3
- package/docs/api/types/AgentFactory.html +2 -2
- package/docs/api/types/AgentOverrides.html +2 -2
- package/docs/api/types/AutopilotPhase.html +2 -2
- package/docs/api/types/AutopilotSignal.html +2 -2
- package/docs/api/types/CommandScope.html +2 -2
- package/docs/api/types/ContextPriority.html +3 -3
- package/docs/api/types/ContextSourceType.html +3 -3
- package/docs/api/types/DelegationProvider.html +2 -2
- package/docs/api/types/DelegationTool.html +2 -2
- package/docs/api/types/ExecutionMode.html +3 -3
- package/docs/api/types/ExternalModelProvider.html +2 -2
- package/docs/api/types/GateType.html +3 -3
- package/docs/api/types/InjectionStrategy.html +2 -2
- package/docs/api/types/KeywordType.html +10 -10
- package/docs/api/types/ModelType.html +2 -2
- package/docs/api/types/QAStatus.html +2 -2
- package/docs/api/types/RecoveryErrorType.html +2 -2
- package/docs/api/types/RecoveryStoredPart.html +2 -2
- package/docs/api/types/TaskTool.html +1 -1
- package/docs/api/types/ThinkingConfig.html +2 -2
- package/docs/api/types/UltraQAGoalType.html +1 -1
- package/docs/api/types/UserStoryInput.html +2 -2
- package/docs/api/types/ValidationVerdict.html +2 -2
- package/docs/api/types/ValidationVerdictType.html +2 -2
- package/docs/api/variables/AGENTS_DIR.html +1 -1
- package/docs/api/variables/AGENTS_FILENAME.html +2 -2
- package/docs/api/variables/AGENT_TOOLS.html +2 -2
- package/docs/api/variables/ALLOWED_PATH_PREFIX.html +2 -2
- package/docs/api/variables/ANALYST_PROMPT_METADATA.html +1 -1
- package/docs/api/variables/ARCHITECT_PROMPT_METADATA.html +1 -1
- package/docs/api/variables/AUTO_SLASH_COMMAND_HOOK_NAME.html +4 -4
- package/docs/api/variables/AUTO_SLASH_COMMAND_TAG_CLOSE.html +1 -1
- package/docs/api/variables/AUTO_SLASH_COMMAND_TAG_OPEN.html +2 -2
- package/docs/api/variables/BACKGROUND_NOTIFICATION_HOOK_NAME.html +2 -2
- package/docs/api/variables/BDD_KEYWORDS.html +2 -2
- package/docs/api/variables/BEADS_INSTRUCTIONS.html +1 -1
- package/docs/api/variables/BEADS_RUST_INSTRUCTIONS.html +1 -1
- package/docs/api/variables/BLOCKING_PATTERNS.html +3 -3
- package/docs/api/variables/BOULDER_CONTINUATION_PROMPT.html +2 -2
- package/docs/api/variables/BOULDER_DIR.html +2 -2
- package/docs/api/variables/BOULDER_FILE.html +2 -2
- package/docs/api/variables/BOULDER_STATE_PATH.html +2 -2
- package/docs/api/variables/CHARS_PER_TOKEN.html +2 -2
- package/docs/api/variables/CI_COMMANDS.html +2 -2
- package/docs/api/variables/CI_GATE_MESSAGE.html +1 -1
- package/docs/api/variables/CLAUDE_CONFIG_DIR.html +2 -2
- package/docs/api/variables/CLAUDE_DEFAULT_CONTEXT_LIMIT.html +2 -2
- package/docs/api/variables/COMMANDS_DIR.html +1 -1
- package/docs/api/variables/COMMENT_CHECKER_MESSAGE_HEADER.html +2 -2
- package/docs/api/variables/COMPACTION_COOLDOWN_MS.html +2 -2
- package/docs/api/variables/CONTENT_PART_TYPES.html +2 -2
- package/docs/api/variables/CONTEXT_CRITICAL_MESSAGE.html +2 -2
- package/docs/api/variables/CONTEXT_FILENAMES.html +2 -2
- package/docs/api/variables/CONTEXT_LIMIT_RECOVERY_MESSAGE.html +2 -2
- package/docs/api/variables/CONTEXT_LIMIT_SHORT_MESSAGE.html +2 -2
- package/docs/api/variables/CONTEXT_WARNING_MESSAGE.html +2 -2
- package/docs/api/variables/CRITICAL_THRESHOLD.html +2 -2
- package/docs/api/variables/CRITIC_PROMPT_METADATA.html +1 -1
- package/docs/api/variables/DEFAULT_CONFIG.html +2 -2
- package/docs/api/variables/DEFAULT_MAX_BACKGROUND_TASKS.html +2 -2
- package/docs/api/variables/DEFAULT_THINKING_CONTENT.html +2 -2
- package/docs/api/variables/DIRECT_WORK_REMINDER.html +2 -2
- package/docs/api/variables/DOCUMENT_SPECIALIST_PROMPT_METADATA.html +1 -1
- package/docs/api/variables/DOCUMENT_WRITER_PROMPT_METADATA.html +1 -1
- package/docs/api/variables/EDIT_ERROR_PATTERNS.html +2 -2
- package/docs/api/variables/EDIT_ERROR_REMINDER.html +3 -3
- package/docs/api/variables/EMPTY_MESSAGE_SANITIZER_DEBUG_PREFIX.html +2 -2
- package/docs/api/variables/EMPTY_MESSAGE_SANITIZER_ERROR_PATTERNS.html +2 -2
- package/docs/api/variables/EMPTY_MESSAGE_SANITIZER_HOOK_NAME.html +2 -2
- package/docs/api/variables/ENTRY_SEPARATOR.html +1 -1
- package/docs/api/variables/EXCLUDED_COMMANDS.html +3 -3
- package/docs/api/variables/EXPERT_GATE_MESSAGE.html +1 -1
- package/docs/api/variables/EXPLORE_PROMPT_METADATA.html +1 -1
- package/docs/api/variables/EXTENSION_TO_LANGUAGE.html +2 -2
- package/docs/api/variables/FEATURE_FLAG_KEY.html +2 -2
- package/docs/api/variables/FRONTEND_ENGINEER_PROMPT_METADATA.html +1 -1
- package/docs/api/variables/GITHUB_API_URL.html +1 -1
- package/docs/api/variables/INSTALLER_CLAUDE_CONFIG_DIR.html +2 -2
- package/docs/api/variables/INSTALLER_VERSION.html +2 -2
- package/docs/api/variables/LINE_COMMENT_PATTERNS.html +2 -2
- package/docs/api/variables/LONG_RUNNING_PATTERNS.html +3 -3
- package/docs/api/variables/MANUAL_HEADER.html +1 -1
- package/docs/api/variables/MAX_SKILLS_PER_SESSION.html +2 -2
- package/docs/api/variables/MAX_SKILL_CONTENT_LENGTH.html +2 -2
- package/docs/api/variables/MAX_WARNINGS.html +2 -2
- package/docs/api/variables/MIN_QUALITY_SCORE.html +2 -2
- package/docs/api/variables/MODE_CONFIGS.html +4 -4
- package/docs/api/variables/MULTIMODAL_LOOKER_PROMPT_METADATA.html +1 -1
- package/docs/api/variables/NON_EMPTY_CONTENT_RECOVERY_MESSAGE.html +2 -2
- package/docs/api/variables/NON_INTERACTIVE_ENV.html +1 -1
- package/docs/api/variables/NON_INTERACTIVE_ENV_HOOK_NAME.html +1 -1
- package/docs/api/variables/NOTEPAD_BASE_PATH.html +2 -2
- package/docs/api/variables/NOTEPAD_DEFAULT_CONFIG.html +1 -1
- package/docs/api/variables/NOTEPAD_DIR.html +2 -2
- package/docs/api/variables/NOTEPAD_FILENAME.html +1 -1
- package/docs/api/variables/OMC_ORCHESTRATOR_HOOK_NAME.html +4 -4
- package/docs/api/variables/ORCHESTRATOR_DELEGATION_REQUIRED.html +2 -2
- package/docs/api/variables/PATTERNS_HEADER.html +1 -1
- package/docs/api/variables/PLACEHOLDER_TEXT.html +3 -3
- package/docs/api/variables/PLANNER_PLANS_DIR.html +2 -2
- package/docs/api/variables/PLANNER_PROMPT_METADATA.html +1 -1
- package/docs/api/variables/PLAN_EXTENSION.html +2 -2
- package/docs/api/variables/PRD_EXAMPLE_FILENAME.html +1 -1
- package/docs/api/variables/PRD_FILENAME.html +1 -1
- package/docs/api/variables/PREEMPTIVE_DEFAULT_THRESHOLD.html +2 -2
- package/docs/api/variables/PREVENTED_ERROR.html +2 -2
- package/docs/api/variables/PRIORITY_HEADER.html +1 -1
- package/docs/api/variables/PROGRESS_FILENAME.html +1 -1
- package/docs/api/variables/PROJECT_MARKERS.html +2 -2
- package/docs/api/variables/PROJECT_RULE_FILES.html +2 -2
- package/docs/api/variables/PROJECT_RULE_SUBDIRS.html +2 -2
- package/docs/api/variables/PROJECT_SKILLS_SUBDIR.html +2 -2
- package/docs/api/variables/RAPID_FIRE_DEBOUNCE_MS.html +7 -7
- package/docs/api/variables/README_FILENAME.html +2 -2
- package/docs/api/variables/README_INJECTOR_STORAGE.html +1 -1
- package/docs/api/variables/README_TRACKED_TOOLS.html +2 -2
- package/docs/api/variables/RECOVERY_FAILED_MESSAGE.html +2 -2
- package/docs/api/variables/RECOVERY_MESSAGES.html +2 -2
- package/docs/api/variables/RECOVERY_PLACEHOLDER_TEXT.html +2 -2
- package/docs/api/variables/REMINDER_MESSAGE.html +2 -2
- package/docs/api/variables/REPO_NAME.html +1 -1
- package/docs/api/variables/REPO_OWNER.html +2 -2
- package/docs/api/variables/RETRY_CONFIG.html +6 -6
- package/docs/api/variables/RULES_INJECTOR_STORAGE.html +1 -1
- package/docs/api/variables/RULE_EXTENSIONS.html +2 -2
- package/docs/api/variables/SHELL_COMMAND_PATTERNS.html +3 -3
- package/docs/api/variables/SINGLE_TASK_DIRECTIVE.html +2 -2
- package/docs/api/variables/SISYPHUS_JUNIOR_PROMPT_METADATA.html +1 -1
- package/docs/api/variables/SKILL_EXTENSION.html +2 -2
- package/docs/api/variables/SLASH_COMMAND_PATTERN.html +2 -2
- package/docs/api/variables/STALE_STATE_MAX_AGE_MS.html +2 -2
- package/docs/api/variables/SYNTHETIC_THINKING_ID_PREFIX.html +2 -2
- package/docs/api/variables/TARGET_TOOLS.html +2 -2
- package/docs/api/variables/THINKING_BLOCK_VALIDATOR_HOOK_NAME.html +2 -2
- package/docs/api/variables/THINKING_CONFIGS.html +2 -2
- package/docs/api/variables/THINKING_MODEL_PATTERNS.html +3 -3
- package/docs/api/variables/THINKING_PART_TYPES.html +2 -2
- package/docs/api/variables/TOKEN_LIMIT_KEYWORDS.html +2 -2
- package/docs/api/variables/TOKEN_LIMIT_PATTERNS.html +2 -2
- package/docs/api/variables/TOOL_PART_TYPES.html +2 -2
- package/docs/api/variables/TRACKED_TOOLS.html +2 -2
- package/docs/api/variables/TRUNCATE_CONFIG.html +6 -6
- package/docs/api/variables/TRUNCATION_APPLIED_MESSAGE.html +2 -2
- package/docs/api/variables/TYPE_CHECKER_PREFIXES.html +2 -2
- package/docs/api/variables/ULTRAPILOT_DEFAULT_CONFIG.html +2 -2
- package/docs/api/variables/USER_GATE_MESSAGE.html +1 -1
- package/docs/api/variables/USER_RULE_DIR.html +2 -2
- package/docs/api/variables/USER_SKILLS_DIR.html +2 -2
- package/docs/api/variables/VERIFICATION_REMINDER.html +2 -2
- package/docs/api/variables/VERSION_FILE.html +1 -1
- package/docs/api/variables/WORKING_MEMORY_HEADER.html +1 -1
- package/docs/api/variables/WRITE_EDIT_TOOLS.html +2 -2
- package/docs/api/variables/allCustomTools.html +3 -3
- package/docs/api/variables/analystAgent.html +1 -1
- package/docs/api/variables/architectAgent.html +1 -1
- package/docs/api/variables/astTools.html +2 -2
- package/docs/api/variables/contextCollector.html +2 -2
- package/docs/api/variables/criticAgent.html +1 -1
- package/docs/api/variables/designerAgent.html +1 -1
- package/docs/api/variables/executorAgent.html +1 -1
- package/docs/api/variables/exploreAgent.html +1 -1
- package/docs/api/variables/lspTools.html +2 -2
- package/docs/api/variables/nonInteractiveEnvHook.html +8 -8
- package/docs/api/variables/omcSystemPrompt.html +2 -2
- package/docs/api/variables/omcToolNames.html +3 -3
- package/docs/api/variables/omcToolsServer.html +4 -4
- package/docs/api/variables/plannerAgent.html +1 -1
- package/docs/api/variables/researcherAgent.html +1 -1
- package/docs/api/variables/visionAgent.html +1 -1
- package/docs/api/variables/writerAgent.html +1 -1
- package/hooks/run-hook.cmd +0 -0
- package/hooks/session-start +0 -0
- package/package.json +1 -1
- package/scripts/persistent-mode.cjs +605 -605
- package/skills/release/SKILL.md +76 -2
- package/skills/systematic-debugging/find-polluter.sh +0 -0
- package/skills/writing-skills/graphviz-conventions.dot +171 -171
- package/skills/writing-skills/render-graphs.js +0 -0
- package/templates/axiom/scripts/Check-Memory.ps1 +68 -68
- package/templates/axiom/scripts/Poll-Memory.ps1 +36 -36
- package/templates/axiom/scripts/Watch-Memory.ps1 +149 -149
- package/templates/axiom/scripts/agent-runner.ps1 +101 -101
- package/templates/axiom/scripts/start-reviews.ps1 +19 -19
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BackgroundNotificationHookOutput | ultrapower API Documentation - v5.5.18</title><meta name="description" content="Documentation for ultrapower API Documentation"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">ultrapower API Documentation - v5.5.18</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">BackgroundNotificationHookOutput</a></li></ul><h1>Interface BackgroundNotificationHookOutput</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Output from background notification hook</p>
|
|
2
|
-
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">BackgroundNotificationHookOutput</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#continue">continue</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#message">message</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#notificationcount">notificationCount</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/hooks/background-notification/types.ts#L51">hooks/background-notification/types.ts:51</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#continue" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>continue</span></a>
|
|
3
|
-
<a href="#message" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message?</span></a>
|
|
4
|
-
<a href="#notificationcount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>notification<wbr/>Count?</span></a>
|
|
5
|
-
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="continue"><span>continue</span><a href="#continue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">continue</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether to continue with the operation</p>
|
|
6
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/hooks/background-notification/types.ts#L53">hooks/background-notification/types.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="message"><code class="tsd-tag">Optional</code><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Notification message to inject into context</p>
|
|
7
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/hooks/background-notification/types.ts#L55">hooks/background-notification/types.ts:55</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="notificationcount"><code class="tsd-tag">Optional</code><span>notification<wbr/>Count</span><a href="#notificationcount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">notificationCount</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Number of tasks with notifications</p>
|
|
8
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/hooks/background-notification/types.ts#L57">hooks/background-notification/types.ts:57</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#continue"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>continue</span></a><a href="#message"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#notificationcount"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>notification<wbr/>Count</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">ultrapower API Documentation - v5.5.18</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BackgroundNotificationHookOutput | ultrapower API Documentation - v5.5.18</title><meta name="description" content="Documentation for ultrapower API Documentation"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">ultrapower API Documentation - v5.5.18</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">BackgroundNotificationHookOutput</a></li></ul><h1>Interface BackgroundNotificationHookOutput</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Output from background notification hook</p>
|
|
2
|
+
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">BackgroundNotificationHookOutput</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#continue">continue</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#message">message</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#notificationcount">notificationCount</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/hooks/background-notification/types.ts#L51">hooks/background-notification/types.ts:51</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#continue" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>continue</span></a>
|
|
3
|
+
<a href="#message" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message?</span></a>
|
|
4
|
+
<a href="#notificationcount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>notification<wbr/>Count?</span></a>
|
|
5
|
+
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="continue"><span>continue</span><a href="#continue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">continue</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether to continue with the operation</p>
|
|
6
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/hooks/background-notification/types.ts#L53">hooks/background-notification/types.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="message"><code class="tsd-tag">Optional</code><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Notification message to inject into context</p>
|
|
7
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/hooks/background-notification/types.ts#L55">hooks/background-notification/types.ts:55</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="notificationcount"><code class="tsd-tag">Optional</code><span>notification<wbr/>Count</span><a href="#notificationcount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">notificationCount</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Number of tasks with notifications</p>
|
|
8
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/hooks/background-notification/types.ts#L57">hooks/background-notification/types.ts:57</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#continue"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>continue</span></a><a href="#message"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#notificationcount"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>notification<wbr/>Count</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">ultrapower API Documentation - v5.5.18</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BackgroundTask | ultrapower API Documentation - v5.5.18</title><meta name="description" content="Documentation for ultrapower API Documentation"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">ultrapower API Documentation - v5.5.18</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">BackgroundTask</a></li></ul><h1>Interface BackgroundTask</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">BackgroundTask</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#id">id</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#agentname">agentName</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#prompt">prompt</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#status">status</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"running"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"completed"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"error"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pending"</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#result">result</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#error">error</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/shared/types.ts#L117">shared/types.ts:117</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a>
|
|
2
|
-
<a href="#agentname" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>agent<wbr/>Name</span></a>
|
|
3
|
-
<a href="#prompt" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prompt</span></a>
|
|
4
|
-
<a href="#status" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a>
|
|
5
|
-
<a href="#result" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>result?</span></a>
|
|
6
|
-
<a href="#error" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>error?</span></a>
|
|
7
|
-
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="id"><span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/shared/types.ts#L118">shared/types.ts:118</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="agentname"><span>agent<wbr/>Name</span><a href="#agentname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">agentName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/shared/types.ts#L119">shared/types.ts:119</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="prompt"><span>prompt</span><a href="#prompt" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prompt</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/shared/types.ts#L120">shared/types.ts:120</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="status"><span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"running"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"completed"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"error"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pending"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/shared/types.ts#L121">shared/types.ts:121</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="result"><code class="tsd-tag">Optional</code><span>result</span><a href="#result" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">result</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/shared/types.ts#L122">shared/types.ts:122</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="error"><code class="tsd-tag">Optional</code><span>error</span><a href="#error" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">error</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/shared/types.ts#L123">shared/types.ts:123</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#id"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a><a href="#agentname"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>agent<wbr/>Name</span></a><a href="#prompt"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prompt</span></a><a href="#status"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#result"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>result</span></a><a href="#error"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>error</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">ultrapower API Documentation - v5.5.18</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BackgroundTask | ultrapower API Documentation - v5.5.18</title><meta name="description" content="Documentation for ultrapower API Documentation"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">ultrapower API Documentation - v5.5.18</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">BackgroundTask</a></li></ul><h1>Interface BackgroundTask</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">BackgroundTask</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#id">id</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#agentname">agentName</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#prompt">prompt</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#status">status</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"running"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"completed"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"error"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pending"</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#result">result</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#error">error</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/shared/types.ts#L117">shared/types.ts:117</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a>
|
|
2
|
+
<a href="#agentname" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>agent<wbr/>Name</span></a>
|
|
3
|
+
<a href="#prompt" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prompt</span></a>
|
|
4
|
+
<a href="#status" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a>
|
|
5
|
+
<a href="#result" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>result?</span></a>
|
|
6
|
+
<a href="#error" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>error?</span></a>
|
|
7
|
+
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="id"><span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/shared/types.ts#L118">shared/types.ts:118</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="agentname"><span>agent<wbr/>Name</span><a href="#agentname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">agentName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/shared/types.ts#L119">shared/types.ts:119</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="prompt"><span>prompt</span><a href="#prompt" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prompt</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/shared/types.ts#L120">shared/types.ts:120</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="status"><span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"running"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"completed"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"error"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pending"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/shared/types.ts#L121">shared/types.ts:121</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="result"><code class="tsd-tag">Optional</code><span>result</span><a href="#result" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">result</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/shared/types.ts#L122">shared/types.ts:122</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="error"><code class="tsd-tag">Optional</code><span>error</span><a href="#error" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">error</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/shared/types.ts#L123">shared/types.ts:123</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#id"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a><a href="#agentname"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>agent<wbr/>Name</span></a><a href="#prompt"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prompt</span></a><a href="#status"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a><a href="#result"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>result</span></a><a href="#error"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>error</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">ultrapower API Documentation - v5.5.18</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,26 +1,26 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BackgroundTaskManager | ultrapower API Documentation - v5.5.18</title><meta name="description" content="Documentation for ultrapower API Documentation"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">ultrapower API Documentation - v5.5.18</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">BackgroundTaskManager</a></li></ul><h1>Interface BackgroundTaskManager</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>BackgroundTaskManager interface</p>
|
|
2
|
-
<p>Manages background task lifecycle, enforces concurrency limits,
|
|
3
|
-
and provides utilities for tracking task status.</p>
|
|
4
|
-
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">BackgroundTaskManager</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-call-signature" href="#registertask-1">registerTask</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">agentName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">prompt</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="BackgroundTask.html" class="tsd-signature-type tsd-kind-interface">BackgroundTask</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#gettasks-1">getTasks</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="BackgroundTask.html" class="tsd-signature-type tsd-kind-interface">BackgroundTask</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#gettasksbystatus-1">getTasksByStatus</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">status</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"running"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"completed"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"error"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pending"</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="BackgroundTask.html" class="tsd-signature-type tsd-kind-interface">BackgroundTask</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#getrunningcount-1">getRunningCount</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#canstartnewtask-1">canStartNewTask</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#updatetaskstatus-1">updateTaskStatus</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">taskId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">status</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"running"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"completed"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"error"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pending"</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">result</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#completetask-1">completeTask</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">taskId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">result</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#failtask-1">failTask</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">taskId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#prunecompletedtasks-1">pruneCompletedTasks</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">maxAge</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#getmaxtasks-1">getMaxTasks</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#shouldruninbackground-1">shouldRunInBackground</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">command</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="TaskExecutionDecision.html" class="tsd-signature-type tsd-kind-interface">TaskExecutionDecision</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/features/background-tasks.ts#L192">features/background-tasks.ts:192</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#registertask" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>register<wbr/>Task</span></a>
|
|
5
|
-
<a href="#gettasks" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Tasks</span></a>
|
|
6
|
-
<a href="#gettasksbystatus" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Tasks<wbr/>By<wbr/>Status</span></a>
|
|
7
|
-
<a href="#getrunningcount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Running<wbr/>Count</span></a>
|
|
8
|
-
<a href="#canstartnewtask" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>can<wbr/>Start<wbr/>New<wbr/>Task</span></a>
|
|
9
|
-
<a href="#updatetaskstatus" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Task<wbr/>Status</span></a>
|
|
10
|
-
<a href="#completetask" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>complete<wbr/>Task</span></a>
|
|
11
|
-
<a href="#failtask" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fail<wbr/>Task</span></a>
|
|
12
|
-
<a href="#prunecompletedtasks" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>prune<wbr/>Completed<wbr/>Tasks</span></a>
|
|
13
|
-
<a href="#getmaxtasks" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Max<wbr/>Tasks</span></a>
|
|
14
|
-
<a href="#shouldruninbackground" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>should<wbr/>Run<wbr/>In<wbr/>Background</span></a>
|
|
15
|
-
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="registertask"><span>register<wbr/>Task</span><a href="#registertask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="registertask-1"><span class="tsd-kind-call-signature">registerTask</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">agentName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">prompt</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="BackgroundTask.html" class="tsd-signature-type tsd-kind-interface">BackgroundTask</a><a href="#registertask-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Register a new background task</p>
|
|
16
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">agentName</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">prompt</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="BackgroundTask.html" class="tsd-signature-type tsd-kind-interface">BackgroundTask</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/features/background-tasks.ts#L194">features/background-tasks.ts:194</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="gettasks"><span>get<wbr/>Tasks</span><a href="#gettasks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="gettasks-1"><span class="tsd-kind-call-signature">getTasks</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="BackgroundTask.html" class="tsd-signature-type tsd-kind-interface">BackgroundTask</a><span class="tsd-signature-symbol">[]</span><a href="#gettasks-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get all background tasks</p>
|
|
17
|
-
</div><h4 class="tsd-returns-title">Returns <a href="BackgroundTask.html" class="tsd-signature-type tsd-kind-interface">BackgroundTask</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/features/background-tasks.ts#L197">features/background-tasks.ts:197</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="gettasksbystatus"><span>get<wbr/>Tasks<wbr/>By<wbr/>Status</span><a href="#gettasksbystatus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="gettasksbystatus-1"><span class="tsd-kind-call-signature">getTasksByStatus</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">status</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"running"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"completed"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"error"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pending"</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="BackgroundTask.html" class="tsd-signature-type tsd-kind-interface">BackgroundTask</a><span class="tsd-signature-symbol">[]</span><a href="#gettasksbystatus-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get tasks by status</p>
|
|
18
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">status</span>: <span class="tsd-signature-type">"running"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"completed"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"error"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pending"</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="BackgroundTask.html" class="tsd-signature-type tsd-kind-interface">BackgroundTask</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/features/background-tasks.ts#L200">features/background-tasks.ts:200</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getrunningcount"><span>get<wbr/>Running<wbr/>Count</span><a href="#getrunningcount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getrunningcount-1"><span class="tsd-kind-call-signature">getRunningCount</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#getrunningcount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get count of running tasks</p>
|
|
19
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/features/background-tasks.ts#L203">features/background-tasks.ts:203</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="canstartnewtask"><span>can<wbr/>Start<wbr/>New<wbr/>Task</span><a href="#canstartnewtask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="canstartnewtask-1"><span class="tsd-kind-call-signature">canStartNewTask</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#canstartnewtask-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Check if we can start a new background task</p>
|
|
20
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/features/background-tasks.ts#L206">features/background-tasks.ts:206</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="updatetaskstatus"><span>update<wbr/>Task<wbr/>Status</span><a href="#updatetaskstatus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="updatetaskstatus-1"><span class="tsd-kind-call-signature">updateTaskStatus</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">taskId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">status</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"running"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"completed"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"error"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pending"</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">result</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#updatetaskstatus-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Update task status</p>
|
|
21
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">taskId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">status</span>: <span class="tsd-signature-type">"running"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"completed"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"error"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pending"</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">result</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/features/background-tasks.ts#L209">features/background-tasks.ts:209</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="completetask"><span>complete<wbr/>Task</span><a href="#completetask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="completetask-1"><span class="tsd-kind-call-signature">completeTask</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">taskId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">result</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#completetask-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Mark task as completed</p>
|
|
22
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">taskId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">result</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/features/background-tasks.ts#L212">features/background-tasks.ts:212</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="failtask"><span>fail<wbr/>Task</span><a href="#failtask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="failtask-1"><span class="tsd-kind-call-signature">failTask</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">taskId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#failtask-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Mark task as failed</p>
|
|
23
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">taskId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/features/background-tasks.ts#L215">features/background-tasks.ts:215</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="prunecompletedtasks"><span>prune<wbr/>Completed<wbr/>Tasks</span><a href="#prunecompletedtasks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="prunecompletedtasks-1"><span class="tsd-kind-call-signature">pruneCompletedTasks</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">maxAge</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#prunecompletedtasks-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Remove completed tasks older than specified age (ms)</p>
|
|
24
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">maxAge</span>: <span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/features/background-tasks.ts#L218">features/background-tasks.ts:218</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getmaxtasks"><span>get<wbr/>Max<wbr/>Tasks</span><a href="#getmaxtasks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getmaxtasks-1"><span class="tsd-kind-call-signature">getMaxTasks</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#getmaxtasks-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the maximum allowed background tasks</p>
|
|
25
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/features/background-tasks.ts#L221">features/background-tasks.ts:221</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="shouldruninbackground"><span>should<wbr/>Run<wbr/>In<wbr/>Background</span><a href="#shouldruninbackground" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="shouldruninbackground-1"><span class="tsd-kind-call-signature">shouldRunInBackground</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">command</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="TaskExecutionDecision.html" class="tsd-signature-type tsd-kind-interface">TaskExecutionDecision</a><a href="#shouldruninbackground-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Check if a command should run in background</p>
|
|
26
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">command</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="TaskExecutionDecision.html" class="tsd-signature-type tsd-kind-interface">TaskExecutionDecision</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/features/background-tasks.ts#L224">features/background-tasks.ts:224</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#registertask"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>register<wbr/>Task</span></a><a href="#gettasks"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Tasks</span></a><a href="#gettasksbystatus"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Tasks<wbr/>By<wbr/>Status</span></a><a href="#getrunningcount"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Running<wbr/>Count</span></a><a href="#canstartnewtask"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>can<wbr/>Start<wbr/>New<wbr/>Task</span></a><a href="#updatetaskstatus"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Task<wbr/>Status</span></a><a href="#completetask"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>complete<wbr/>Task</span></a><a href="#failtask"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fail<wbr/>Task</span></a><a href="#prunecompletedtasks"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>prune<wbr/>Completed<wbr/>Tasks</span></a><a href="#getmaxtasks"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Max<wbr/>Tasks</span></a><a href="#shouldruninbackground"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>should<wbr/>Run<wbr/>In<wbr/>Background</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">ultrapower API Documentation - v5.5.18</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BackgroundTaskManager | ultrapower API Documentation - v5.5.18</title><meta name="description" content="Documentation for ultrapower API Documentation"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">ultrapower API Documentation - v5.5.18</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">BackgroundTaskManager</a></li></ul><h1>Interface BackgroundTaskManager</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>BackgroundTaskManager interface</p>
|
|
2
|
+
<p>Manages background task lifecycle, enforces concurrency limits,
|
|
3
|
+
and provides utilities for tracking task status.</p>
|
|
4
|
+
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">BackgroundTaskManager</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-call-signature" href="#registertask-1">registerTask</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">agentName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">prompt</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="BackgroundTask.html" class="tsd-signature-type tsd-kind-interface">BackgroundTask</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#gettasks-1">getTasks</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="BackgroundTask.html" class="tsd-signature-type tsd-kind-interface">BackgroundTask</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#gettasksbystatus-1">getTasksByStatus</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">status</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"running"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"completed"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"error"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pending"</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="BackgroundTask.html" class="tsd-signature-type tsd-kind-interface">BackgroundTask</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#getrunningcount-1">getRunningCount</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#canstartnewtask-1">canStartNewTask</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#updatetaskstatus-1">updateTaskStatus</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">taskId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">status</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"running"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"completed"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"error"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pending"</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">result</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#completetask-1">completeTask</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">taskId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">result</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#failtask-1">failTask</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">taskId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#prunecompletedtasks-1">pruneCompletedTasks</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">maxAge</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#getmaxtasks-1">getMaxTasks</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#shouldruninbackground-1">shouldRunInBackground</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">command</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="TaskExecutionDecision.html" class="tsd-signature-type tsd-kind-interface">TaskExecutionDecision</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/features/background-tasks.ts#L192">features/background-tasks.ts:192</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#registertask" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>register<wbr/>Task</span></a>
|
|
5
|
+
<a href="#gettasks" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Tasks</span></a>
|
|
6
|
+
<a href="#gettasksbystatus" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Tasks<wbr/>By<wbr/>Status</span></a>
|
|
7
|
+
<a href="#getrunningcount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Running<wbr/>Count</span></a>
|
|
8
|
+
<a href="#canstartnewtask" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>can<wbr/>Start<wbr/>New<wbr/>Task</span></a>
|
|
9
|
+
<a href="#updatetaskstatus" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Task<wbr/>Status</span></a>
|
|
10
|
+
<a href="#completetask" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>complete<wbr/>Task</span></a>
|
|
11
|
+
<a href="#failtask" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fail<wbr/>Task</span></a>
|
|
12
|
+
<a href="#prunecompletedtasks" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>prune<wbr/>Completed<wbr/>Tasks</span></a>
|
|
13
|
+
<a href="#getmaxtasks" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Max<wbr/>Tasks</span></a>
|
|
14
|
+
<a href="#shouldruninbackground" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>should<wbr/>Run<wbr/>In<wbr/>Background</span></a>
|
|
15
|
+
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="registertask"><span>register<wbr/>Task</span><a href="#registertask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="registertask-1"><span class="tsd-kind-call-signature">registerTask</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">agentName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">prompt</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="BackgroundTask.html" class="tsd-signature-type tsd-kind-interface">BackgroundTask</a><a href="#registertask-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Register a new background task</p>
|
|
16
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">agentName</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">prompt</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="BackgroundTask.html" class="tsd-signature-type tsd-kind-interface">BackgroundTask</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/features/background-tasks.ts#L194">features/background-tasks.ts:194</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="gettasks"><span>get<wbr/>Tasks</span><a href="#gettasks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="gettasks-1"><span class="tsd-kind-call-signature">getTasks</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="BackgroundTask.html" class="tsd-signature-type tsd-kind-interface">BackgroundTask</a><span class="tsd-signature-symbol">[]</span><a href="#gettasks-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get all background tasks</p>
|
|
17
|
+
</div><h4 class="tsd-returns-title">Returns <a href="BackgroundTask.html" class="tsd-signature-type tsd-kind-interface">BackgroundTask</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/features/background-tasks.ts#L197">features/background-tasks.ts:197</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="gettasksbystatus"><span>get<wbr/>Tasks<wbr/>By<wbr/>Status</span><a href="#gettasksbystatus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="gettasksbystatus-1"><span class="tsd-kind-call-signature">getTasksByStatus</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">status</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"running"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"completed"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"error"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pending"</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="BackgroundTask.html" class="tsd-signature-type tsd-kind-interface">BackgroundTask</a><span class="tsd-signature-symbol">[]</span><a href="#gettasksbystatus-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get tasks by status</p>
|
|
18
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">status</span>: <span class="tsd-signature-type">"running"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"completed"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"error"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pending"</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="BackgroundTask.html" class="tsd-signature-type tsd-kind-interface">BackgroundTask</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/features/background-tasks.ts#L200">features/background-tasks.ts:200</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getrunningcount"><span>get<wbr/>Running<wbr/>Count</span><a href="#getrunningcount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getrunningcount-1"><span class="tsd-kind-call-signature">getRunningCount</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#getrunningcount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get count of running tasks</p>
|
|
19
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/features/background-tasks.ts#L203">features/background-tasks.ts:203</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="canstartnewtask"><span>can<wbr/>Start<wbr/>New<wbr/>Task</span><a href="#canstartnewtask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="canstartnewtask-1"><span class="tsd-kind-call-signature">canStartNewTask</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#canstartnewtask-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Check if we can start a new background task</p>
|
|
20
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/features/background-tasks.ts#L206">features/background-tasks.ts:206</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="updatetaskstatus"><span>update<wbr/>Task<wbr/>Status</span><a href="#updatetaskstatus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="updatetaskstatus-1"><span class="tsd-kind-call-signature">updateTaskStatus</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">taskId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">status</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"running"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"completed"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"error"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pending"</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">result</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#updatetaskstatus-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Update task status</p>
|
|
21
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">taskId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">status</span>: <span class="tsd-signature-type">"running"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"completed"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"error"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"pending"</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">result</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/features/background-tasks.ts#L209">features/background-tasks.ts:209</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="completetask"><span>complete<wbr/>Task</span><a href="#completetask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="completetask-1"><span class="tsd-kind-call-signature">completeTask</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">taskId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">result</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#completetask-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Mark task as completed</p>
|
|
22
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">taskId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">result</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/features/background-tasks.ts#L212">features/background-tasks.ts:212</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="failtask"><span>fail<wbr/>Task</span><a href="#failtask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="failtask-1"><span class="tsd-kind-call-signature">failTask</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">taskId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#failtask-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Mark task as failed</p>
|
|
23
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">taskId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/features/background-tasks.ts#L215">features/background-tasks.ts:215</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="prunecompletedtasks"><span>prune<wbr/>Completed<wbr/>Tasks</span><a href="#prunecompletedtasks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="prunecompletedtasks-1"><span class="tsd-kind-call-signature">pruneCompletedTasks</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">maxAge</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#prunecompletedtasks-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Remove completed tasks older than specified age (ms)</p>
|
|
24
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">maxAge</span>: <span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/features/background-tasks.ts#L218">features/background-tasks.ts:218</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getmaxtasks"><span>get<wbr/>Max<wbr/>Tasks</span><a href="#getmaxtasks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getmaxtasks-1"><span class="tsd-kind-call-signature">getMaxTasks</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#getmaxtasks-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the maximum allowed background tasks</p>
|
|
25
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/features/background-tasks.ts#L221">features/background-tasks.ts:221</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="shouldruninbackground"><span>should<wbr/>Run<wbr/>In<wbr/>Background</span><a href="#shouldruninbackground" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="shouldruninbackground-1"><span class="tsd-kind-call-signature">shouldRunInBackground</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">command</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="TaskExecutionDecision.html" class="tsd-signature-type tsd-kind-interface">TaskExecutionDecision</a><a href="#shouldruninbackground-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Check if a command should run in background</p>
|
|
26
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">command</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="TaskExecutionDecision.html" class="tsd-signature-type tsd-kind-interface">TaskExecutionDecision</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/liangjie559567/ultrapower/blob/5f4582b71c94783a800de87711bbc708acb100d9/src/features/background-tasks.ts#L224">features/background-tasks.ts:224</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#registertask"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>register<wbr/>Task</span></a><a href="#gettasks"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Tasks</span></a><a href="#gettasksbystatus"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Tasks<wbr/>By<wbr/>Status</span></a><a href="#getrunningcount"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Running<wbr/>Count</span></a><a href="#canstartnewtask"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>can<wbr/>Start<wbr/>New<wbr/>Task</span></a><a href="#updatetaskstatus"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Task<wbr/>Status</span></a><a href="#completetask"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>complete<wbr/>Task</span></a><a href="#failtask"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fail<wbr/>Task</span></a><a href="#prunecompletedtasks"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>prune<wbr/>Completed<wbr/>Tasks</span></a><a href="#getmaxtasks"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Max<wbr/>Tasks</span></a><a href="#shouldruninbackground"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>should<wbr/>Run<wbr/>In<wbr/>Background</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">ultrapower API Documentation - v5.5.18</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|