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, recurringPeriods) to limit when the rule is evaluated. Scope answers where a rule applies. It does not change the rule’s core meaning. For constraint rules, priority controls enforcement strength. Preference rules document their own priority behavior. Not all rules support all scoping options. Entity-only rules (e.g., maxConsecutiveDays) ignore time scoping.

Extended by

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.