Schedule interface

Configuration options for scheduled functions.

Signature:

export interface Schedule 

Properties

Schedule.retryConfig

Settings that determine the retry behavior.

Signature:

retryConfig?: ScheduleRetryConfig;

Schedule.schedule

Describes the schedule on which the job will be executed.

The schedule can be either of the following types:

1. Crontab

2. English-like schedule

Signature:

schedule: string;

Example

// Crontab schedule
schedule: "0 9 * * 1"` // Every Monday at 09:00 AM

// English-like schedule
schedule: "every 5 minutes"

Schedule.timeZone

Specifies the time zone to be used in interpreting Schedule.schedule.

The value of this field must be a time zone name from the tz database.

Signature:

timeZone?: string | ResetValue;