Skip to main content

SchedulerOptions

SchedulerOptions​

@vendure/corevendure-config.ts
v3.3.0

Options related to scheduled tasks..

Signature
interface SchedulerOptions {
    schedulerStrategy?: SchedulerStrategy;
    tasks?: ScheduledTask[];
    runTasksInWorkerOnly?: boolean;
}

schedulerStrategy​

property
SchedulerStrategy

The strategy used to execute scheduled tasks. If you are using the DefaultSchedulerPlugin (which is recommended) then this will be set to the DefaultSchedulerStrategy.

tasks​

property
ScheduledTask[]

The tasks to be executed.

runTasksInWorkerOnly​

property
boolean
default:
true

Whether to run tasks only in the worker process. Generally this should be left as true, since tasks may involve expensive operations that should not be allowed to interfere with the server responsiveness.

This option mainly exists for testing purposes.