Skip to main content
Assignable shift option resolved at day level. A shift pattern is a template that repeats across scheduling days. The solver may assign eligible members to the full pattern window when doing so helps satisfy coverage requirements and rules.

​
Properties

​
dayOfWeek?: readonly [DayOfWeek, DayOfWeek]
Restricts which days of the week this shift pattern can be used.
  • If omitted: shift can be used on any day
  • If provided: shift can only be assigned on the specified days
​
TimeOfDay
required
When the shift ends (e.g., { hours: 17, minutes: 30 } for 5:30 PM)
​
string
required
Unique identifier for this shift pattern. Used in assignments and rule configurations.
​
locationId?: string
Physical location where this shift takes place. Used for multi-location scheduling and location-based constraints.
​
roleIds?: [string, ...string[]]
Restricts who can be assigned to this shift based on their role IDs.
  • If omitted: anyone can work this shift
  • If provided: only team members whose roles overlap with this list can be assigned
Most venues have the same shifts for everyone and don’t need this. Use it when different roles have different schedules (e.g., kitchen staff starts earlier than floor staff).
​
TimeOfDay
required
When the shift starts (e.g., { hours: 9, minutes: 0 } for 9:00 AM)