Skip to main content
Configuration for scheduleWithRuleRegistry. Unlike ScheduleConfig, this config does not implicitly include the built-in rule registry. The provided registry is the complete active rule registry for the schedule.

​
Type Parameters

​
R

R extends readonly string[] = readonly string[]

​
S

S extends readonly string[] = readonly []

​
T

T extends Record<string, SemanticTimeEntry> = Record<string, SemanticTimeEntry>

​
TRuleRegistry

TRuleRegistry extends CpsatRuleRegistry = CpsatRuleRegistry

​
Properties

​
coverage
NoInfer<CoverageEntry<keyof T & string, R[number] | S[number]>>[]
required
Staffing requirements per time period (entries stack additively).
​
dayOfWeek
dayOfWeek?: readonly [DayOfWeek, DayOfWeek]
Days of the week the business operates (inclusion filter).
​
members
members?: SchedulingMember[]
Team members (typically added via .with() at runtime).
​
roleIds
R
required
Declared role IDs.
​
rules
rules?: ScheduleRuleEntry<TRuleRegistry>[]
Scheduling rules and constraints.
​
shiftPatterns
ShiftPattern[]
required
Available shift patterns.
​
skillIds
skillIds?: S
Declared skill IDs. When omitted, coverage targets can only be roles.
​
times
T
required
Named semantic time periods.
​
weekStartsOn
weekStartsOn?: DayOfWeek
Which day starts the week for weekly rules. Defaults to "monday".