Interface SchedulerService

Deals with the scheduling of distributed tasks, for a given plugin.

See the service documentation for more details.

interface SchedulerService {
    createScheduledTaskRunner(
        schedule: SchedulerServiceTaskScheduleDefinition,
    ): SchedulerServiceTaskRunner;
    getScheduledTasks(): Promise<SchedulerServiceTaskDescriptor[]>;
    scheduleTask(
        task: SchedulerServiceTaskScheduleDefinition & SchedulerServiceTaskInvocationDefinition,
    ): Promise<void>;
    triggerTask(id: string): Promise<void>;
}

Index

Methods

createScheduledTaskRunner getScheduledTasks scheduleTask triggerTask

Methods

createScheduledTaskRunner

createScheduledTaskRunner(
schedule: SchedulerServiceTaskScheduleDefinition,
): SchedulerServiceTaskRunner
Creates a scheduled but dormant recurring task, ready to be launched at a later time.
Parameters
- schedule: SchedulerServiceTaskScheduleDefinition
  The task schedule
Returns SchedulerServiceTaskRunner
Remarks
This method is useful for pre-creating a schedule in outer code to be passed into an inner implementation, such that the outer code controls scheduling while inner code controls implementation.
- Defined in packages/backend-plugin-api/src/services/definitions/SchedulerService.ts:337

getScheduledTasks

getScheduledTasks(): Promise<SchedulerServiceTaskDescriptor[]>
Returns all scheduled tasks registered to this scheduler.

Returns Promise<SchedulerServiceTaskDescriptor[]>
Scheduled tasks

Remarks
This method is useful for triggering tasks manually using the triggerTask functionality. Note that the returned tasks contain only tasks that have been initialized in this instance of the scheduler.
- Defined in packages/backend-plugin-api/src/services/definitions/SchedulerService.ts:352

scheduleTask

scheduleTask(
task: SchedulerServiceTaskScheduleDefinition & SchedulerServiceTaskInvocationDefinition,
): Promise<void>
Schedules a task function for recurring runs.
Parameters
- task: SchedulerServiceTaskScheduleDefinition & SchedulerServiceTaskInvocationDefinition
  The task definition
Returns Promise<void>
Remarks
The scope task field controls whether to use coordinated exclusive invocation across workers, or to just coordinate within the current worker.

This convenience method performs both the scheduling and invocation in one go.
- Defined in packages/backend-plugin-api/src/services/definitions/SchedulerService.ts:320

triggerTask

triggerTask(id: string): Promise<void>
Manually triggers a task by ID.

If the task doesn't exist, a NotFoundError is thrown. If the task is currently running, a ConflictError is thrown.
Parameters
- id: string
  The task ID
Returns Promise<void>
- Defined in packages/backend-plugin-api/src/services/definitions/SchedulerService.ts:305