DefaultSchedulerPlugin

@vendure/core Sourcev3.3.0

This plugin configures a default scheduling strategy that executes scheduled tasks using the database to ensure that each task is executed exactly once at the scheduled time, even if there are multiple instances of the worker running.

Example

import { DefaultSchedulerPlugin, VendureConfig } from '@vendure/core';export const config: VendureConfig = {  plugins: [    DefaultSchedulerPlugin.init({      // The default is 60s, but you can override it here      defaultTimeout: '10s',    }),  ],};

Signature

class DefaultSchedulerPlugin {    static options: DefaultSchedulerPluginOptions = {        defaultTimeout: DEFAULT_TIMEOUT,        manualTriggerCheckInterval: DEFAULT_MANUAL_TRIGGER_CHECK_INTERVAL,    };    init(config?: DefaultSchedulerPluginOptions) => ;}

options

propertyDefaultSchedulerPluginOptions

init

method(config?: DefaultSchedulerPluginOptions) =>

@vendure/core Sourcev3.3.0

The options for the DefaultSchedulerPlugin.

Signature

interface DefaultSchedulerPluginOptions {    defaultTimeout?: string | number;    manualTriggerCheckInterval?: string | number;}

defaultTimeout

propertystring | number

Default:60_000ms

The default timeout for scheduled tasks.

manualTriggerCheckInterval

propertystring | number

Default:10_000ms

The interval at which the plugin will check for manually triggered tasks.