Skip to content

rulvar API reference


rulvar API reference / @rulvar/core / nextFailover

Function: nextFailover()

ts
function nextFailover(
   targets, 
   trigger, 
   from): number | undefined;

Defined in: packages/core/src/model/failover.ts:51

The next target index past from that serves trigger, or undefined when the chain is exhausted. Index 0 is the primary; the chain never moves backwards (sticky failover).

Parameters

ParameterType
targetsPick<FailoverTarget, "on">[]
triggerFailoverTrigger
fromnumber

Returns

number | undefined