dayOfWeek on
both entries to avoid stacking. See cover for details.
roleIds, times, coverage, and shiftPatterns are required.
These four fields form the minimum solvable schedule.
The TRuleRegistry generic represents the full active rule registry for the
schedule. In schedule(), that registry always includes the built-in rules,
and ruleRegistry adds any custom extensions on top.
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 BuiltInRuleRegistry = BuiltInRuleRegistry
Properties
Staffing requirements per time period (entries stack additively).
Days of the week the business operates (inclusion filter).
Team members (typically added via
.with() at runtime).Declared role IDs.
Additional rule descriptors keyed by rule name.
Scheduling rules and constraints.
Available shift patterns.
Declared skill IDs. When omitted, coverage targets can only be roles.
Named semantic time periods.
Which day starts the week for weekly rules. Defaults to
"monday".