Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.

Skip to main content

Getting Started

Overview
Quickstart

Guides

Rules
Semantic Time
Feedback

Schedule Definition

schedule
partialSchedule
SolveStrategy
SolveResult
SolveOptions
ScheduleConfig<R, S, T, TRuleRegistry>

Time Periods

t
weekdays
weekend
time

Coverage

cover
CoverageVariant
CoverageOptions

Shift Patterns

shift

Rules

maxHoursPerDay
maxHoursPerWeek
minHoursPerDay
minHoursPerWeek
maxDaysPerWeek
minDaysPerWeek
targetDaysPerWeek
maxShiftsPerDay
maxConcurrentAssignments
targetPeakConcurrentAssignments
maxConsecutiveDays
minConsecutiveDays
minRestBetweenShifts
preferAssignment
avoidAssignment
preferRole
preferLocation
mustAssign
timeOff
assignTogether
maxDaysOfWeekPerPeriod
minDaysOfWeekPerPeriod
RuleOptions
EntityOnlyRuleOptions
TimeOffOptions
AssignTogetherOptions
MaxConcurrentAssignmentsOptions
TargetDaysPerWeekOptions
TargetPeakConcurrentAssignmentsOptions
DaysOfWeekPerPeriodOptions

Cost Optimization

minimizeCost
dayMultiplier
daySurcharge
timeSurcharge
overtimeMultiplier
overtimeSurcharge
dailyOvertimeMultiplier
dailyOvertimeSurcharge
tieredOvertimeMultiplier
OvertimeTier
CostRuleOptions

Solver

HttpSolverClient
parseSolverResponse
resolveAssignments
SolverStatus
SolverClient
ShiftAssignment
ResolvedShiftAssignment
SolverResult

Supporting Types

RecurringPeriod
HourlyPay
SalariedPay
Priority
SoftPriority
SchedulingMember
ShiftPattern
DayOfWeek
TimeOfDay
DateString
SchedulingPeriod

Properties

Supporting Types

TimeOfDay

Time of day (24-hour format).

Properties

number

required

number

required

DayOfWeek DateString

⌘I

Powered byThis documentation is built and hosted on Mintlify, a developer documentation platform