Skip to main content

​
Function: createMinHoursWeekRule()

function createMinHoursWeekRule(config): CompilationRule;
Enforces a minimum total number of hours per scheduling week.

​
Parameters

ParameterType
config{ employeeIds?: string[]; hours: number; priority: "LOW" | "MEDIUM" | "HIGH" | "MANDATORY"; roleIds?: string[]; skillIds?: string[]; weekStartsOn?: | "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday" | "sunday"; }
config.employeeIds?string[]
config.hoursnumber
config.priority"LOW" | "MEDIUM" | "HIGH" | "MANDATORY"
config.roleIds?string[]
config.skillIds?string[]
config.weekStartsOn?| "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday" | "sunday"

​
Returns

CompilationRule

​
Example

const rule = createMinHoursWeekRule({
  hours: 30,
  priority: "HIGH",
});
builder = new ModelBuilder({ ...config, rules: [rule] });