Skip to main content

SchedulerService

SchedulerService​

@vendure/corescheduler.service.ts
v3.3.0

The service that is responsible for setting up and querying the scheduled tasks.

Signature
class SchedulerService implements OnApplicationBootstrap, OnApplicationShutdown {
    constructor(configService: ConfigService, processContext: ProcessContext)
    onApplicationBootstrap() => ;
    onApplicationShutdown(signal?: string) => ;
    getTaskList() => Promise<TaskInfo[]>;
    updateTask(input: UpdateScheduledTaskInput) => Promise<TaskInfo>;
    runTask(taskId: string) => Promise<Success>;
}
  • Implements: OnApplicationBootstrap, OnApplicationShutdown

constructor​

method
(configService: ConfigService, processContext: ProcessContext) => SchedulerService

onApplicationBootstrap​

method
() =>

onApplicationShutdown​

method
(signal?: string) =>

getTaskList​

method
() => Promise<TaskInfo[]>

Returns a list of all the scheduled tasks and their current status.

updateTask​

method
(input: UpdateScheduledTaskInput) => Promise<TaskInfo>

runTask​

method
(taskId: string) => Promise<Success>