Skip to main content
Options for timeOff. At least one time scoping field is required (dayOfWeek, dateRange, dates, or recurringPeriods). Use from/until to block only part of a day.

​
Properties

​
appliesTo
appliesTo?: string | string[]
Who this rule applies to (role name, skill name, or member ID).
​
dateRange
dateRange?: object
Restrict to a date range.
​
dates
dates?: string[]
Restrict to specific dates (YYYY-MM-DD).
​
dayOfWeek
dayOfWeek?: readonly [DayOfWeek, DayOfWeek]
Restrict to specific days of the week.
​
from
from?: TimeOfDay
Off from this time until end of day.
​
priority
priority?: "LOW" | "MEDIUM" | "HIGH" | "MANDATORY"
Defaults to "MANDATORY".
​
recurringPeriods
recurringPeriods?: [RecurringPeriod, ...RecurringPeriod[]]
Restrict to recurring calendar periods.
​
until
until?: TimeOfDay
Off from start of day until this time.