Skip to main content

Interface: CalendarSpecDescription

client.CalendarSpecDescription

An event specification relative to the calendar, similar to a traditional cron specification.

A second in time matches if all fields match. This includes dayOfMonth and dayOfWeek.

Properties​

comment​

• Optional comment: string

Description of the intention of this spec.

dayOfMonth​

• dayOfMonth: Range<number>[]

Valid values: 1–31

Default

Match on any day (ie. [{ start: 1, end: 31, step: 1 }])

dayOfWeek​

• dayOfWeek: Range<"SUNDAY" | "MONDAY" | "TUESDAY" | "WEDNESDAY" | "THURSDAY" | "FRIDAY" | "SATURDAY">[]

Valid values are 'SUNDAY' to 'SATURDAY'.

Default

Match on any day of the week (ie. [{ start: 'SUNDAY', end: 'SATURDAY', step: 1 }])

hour​

• hour: Range<number>[]

Valid values: 0–23

Default

Match only when hour is 0 (ie. [{ start: 0, end: 0, step: 0 }])

minute​

• minute: Range<number>[]

Valid values: 0–59

Default

Match only when minute is 0 (ie. [{ start: 0, end: 0, step: 0 }])

month​

• month: Range<"JANUARY" | "FEBRUARY" | "MARCH" | "APRIL" | "MAY" | "JUNE" | "JULY" | "AUGUST" | "SEPTEMBER" | "OCTOBER" | "NOVEMBER" | "DECEMBER">[]

Valid values are 'JANUARY' to 'DECEMBER'.

Default

Match on any month (ie. [{ start: 'JANUARY', end: 'DECEMBER', step: 1 }])

second​

• second: Range<number>[]

Valid values: 0–59

Default

Match only when second is 0 (ie. [{ start: 0, end: 0, step: 0 }])

year​

• year: Range<number>[]

Use full years, like 2030

Default

Match on any year