Skip to main content
Defines a scheduling period as a date range with optional filters. The dateRange specifies the overall scheduling window. Use dayOfWeek and/or dates to narrow which days within the range are included. Filters compose: a day must pass all specified filters to be included.

Examples

All days in a week
Only specific days of the week (closed Mon/Tue)
Only specific dates within the range

Properties

object
required
The overall scheduling window (start and end are inclusive). Dates should be in YYYY-MM-DD format.
dates?: ${number}-${number}-${number}[]
Include only these specific dates (YYYY-MM-DD) within the range. If omitted, all dates in the range are included (subject to dayOfWeek filter).
dayOfWeek?: readonly DayOfWeek[]
Include only these days of the week. If omitted, all days of the week are included.