Skip to main content

Interface: CalendarSpec

client.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

'*'