Skip to main content
function shift(
   id,
   startTime,
   endTime,
   opts?): ShiftPattern;
Define a shift pattern: a time slot available for employee assignment.

​
Parameters

​
id
string
required
​
startTime
required
TimeOfDay
​
endTime
required
TimeOfDay
​
opts
Pick\<[ShiftPattern](./ShiftPattern), "dayOfWeek" | "roleIds" | "locationId"\>

​
Returns

ShiftPattern Each pattern repeats daily unless filtered by dayOfWeek.

​
Example

shiftPatterns: [
  shift("morning", t(11, 30), t(15)),
  shift("evening", t(17), t(22)),

  // Role-restricted shift
  shift("kitchen", t(6), t(14), { roleIds: ["chef", "prep_cook"] }),

  // Day-restricted shift
  shift("saturday_short", t(9), t(14), { dayOfWeek: ["saturday"] }),

  // Location-specific shift
  shift("terrace_lunch", t(12), t(16), { locationId: "terrace" }),
]