Skip to main content
Scoping options shared by most rule functions. Default priority is MANDATORY. Use appliesTo to scope to a role, skill, or member ID. Use time scoping options (dayOfWeek, dateRange, dates) to limit when the rule applies. Not all rules support all scoping options. Entity-only rules (e.g., maxConsecutiveDays) ignore time scoping.

Properties

appliesTo
string | string[]
Who this rule applies to (role name, skill name, or member ID).
dateRange
object
Restrict to a date range.
dates
string[]
Restrict to specific dates (YYYY-MM-DD).
dayOfWeek
readonly [DayOfWeek, DayOfWeek]
Restrict to specific days of the week.
priority
Priority
Defaults to "MANDATORY".
recurringPeriods
[RecurringPeriod, ...RecurringPeriod[]]
Restrict to recurring calendar periods.