Skip to main content
function preferLocation(locationId, opts?): RuleEntry<"location-preference", object & EntityOnlyRuleOptions>;
Steer a member toward shifts at a specific location.

​
Parameters

​
locationId
string
required
The location to prefer
​
opts
EntityOnlyRuleOptionsSee EntityOnlyRuleOptions

​
Returns

RuleEntry<"location-preference", object & EntityOnlyRuleOptions> Penalizes assignment to shift patterns whose locationId does not match the preferred location. The member is still assigned elsewhere when coverage requires it.