Skip to main content

Interface: CalendarSpec

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?​

optional dayOfMonth?: LooseRange<number> | LooseRange<number>[] | "*"

Valid values: 1–31

Default​

'*'

dayOfWeek?​

optional dayOfWeek?: "*" | LooseRange<"SUNDAY" | "MONDAY" | "TUESDAY" | "WEDNESDAY" | "THURSDAY" | "FRIDAY" | "SATURDAY"> | LooseRange<"SUNDAY" | "MONDAY" | "TUESDAY" | "WEDNESDAY" | "THURSDAY" | "FRIDAY" | "SATURDAY">[]

Default​

'*'

hour?​

optional hour?: LooseRange<number> | LooseRange<number>[] | "*"

Valid values: 0–23

Default​

0

minute?​

optional minute?: LooseRange<number> | LooseRange<number>[] | "*"

Valid values: 0–59

Default​

0

month?​

optional month?: "*" | LooseRange<"JANUARY" | "FEBRUARY" | "MARCH" | "APRIL" | "MAY" | "JUNE" | "JULY" | "AUGUST" | "SEPTEMBER" | "OCTOBER" | "NOVEMBER" | "DECEMBER"> | LooseRange<"JANUARY" | "FEBRUARY" | "MARCH" | "APRIL" | "MAY" | "JUNE" | "JULY" | "AUGUST" | "SEPTEMBER" | "OCTOBER" | "NOVEMBER" | "DECEMBER">[]

Default​

'*'

second?​

optional second?: LooseRange<number> | LooseRange<number>[] | "*"

Valid values: 0–59

Default​

0

year?​

optional year?: LooseRange<number> | LooseRange<number>[] | "*"

Use full years, like 2030

Default​

'*'