ScheduledTask | Vendure Docs

Signature

class ScheduledTask<C extends Record<string, any> = Record<string, any>> {    constructor(config: ScheduledTaskConfig<C>)    id: void    options: void    execute(injector: Injector) => ;    configure(update: Partial<Pick<ScheduledTaskConfig<C>, 'schedule' | 'timezone' | 'timeout' | 'params'>>) => ;}

id

property

options

property

execute

method(injector: Injector) =>

configure

method(update: Partial<Pick<ScheduledTaskConfig<C>, 'schedule' | 'timezone' | 'timeout' | 'params'>>) =>

This method allows you to further configure existing scheduled tasks. For example, you may wish to change the schedule, timezone or timeout of a task, without having to define a new task.

Example

import { ScheduledTask } from '@vendure/core';const task = new ScheduledTask({    id: 'test-job',    schedule: cron => cron.every(2).minutes(),    execute: async ({ injector, scheduledContext, params }) => {        // some logic here    },});// later, you can configure the tasktask.configure({ schedule: cron => cron.every(5).minutes() });

Signature

interface ScheduledTaskConfig<C extends Record<string, any> = Record<string, any>> {    id: string;    description?: string;    params?: C;    schedule: string | ((cronTime: typeof CronTime) => string);    timezone?: string;    timeout?: number | string;    preventOverlap?: boolean;    execute(args: ScheduledTaskExecutionArgs<C>): Promise<any>;}

id

propertystring

The unique identifier for the scheduled task.

description

propertystring

The description for the scheduled task.

params

propertyC

Optional parameters that will be passed to the execute function.

schedule

propertystring | ((cronTime: typeof CronTime) => string)

The cron schedule for the scheduled task. This can be a standard cron expression or a function that returns a cron-time-generator expression.

Example

// Standard cron expression{ schedule: '0 0-23/5 * * *', } // every 5 hours{ schedule: '0 22 * * *', } // every day at 10:00 PM// Cron-time-generator expression{ schedule: cronTime => cronTime.every(2).minutes(), }{ schedule: cronTime => cronTime.every(5).hours(), }

timezone

propertystringv3.8.0

Default:undefined

The IANA timezone identifier (e.g. 'Europe/Stockholm', 'America/New_York') in which the cron schedule of this task is evaluated. Takes precedence over the global schedulerOptions.timezone setting. When neither is set, the cron expression is evaluated in the timezone of the Node.js process.

timeout

propertynumber | string

Default:60_000ms

The timeout for the scheduled task. If the task takes longer than the timeout, the task will be considered to have failed with a timeout error.

preventOverlap

propertyboolean

Default:true

Whether the scheduled task should be prevented from running if it is already running.

execute

method(args: ScheduledTaskExecutionArgs<C>) => Promise<any>

The function that will be executed when the scheduled task is run.