HedgingOptions

Defined in: src/hedging.ts:44

Type Parameters

T

T

Properties

actionGenerator?

optional actionGenerator?: (args) => ((context) => MaybePromise<T>) | undefined

Defined in: src/hedging.ts:57

Return a different action for hedged attempts (e.g. another endpoint), or undefined to repeat the original.

Parameters

args

HedgingActionArgs<T>

Returns

((context) => MaybePromise<T>) | undefined

---

delay?

optional delay?: Duration

Defined in: src/hedging.ts:53

ms to wait before starting another attempt. Default 2000. > 0 latency mode, 0 parallel mode (all at once), < 0 fallback mode (next attempt only after a failure).

---

delayGenerator?

optional delayGenerator?: (args) => MaybePromise<Duration | undefined>

Defined in: src/hedging.ts:55

Delay before the attempt about to start; undefined uses delay.

Parameters

args

HedgingDelayArgs

Returns

MaybePromise<Duration | undefined>

---

maxHedgedAttempts?

optional maxHedgedAttempts?: number

Defined in: src/hedging.ts:48

Hedged attempts in addition to the primary. Default 1.

---

name?

optional name?: string

Defined in: src/hedging.ts:45

---

onHedging?

optional onHedging?: (args) => MaybePromise<void>

Defined in: src/hedging.ts:58

Parameters

args

OnHedgingArgs

Returns

MaybePromise<void>

---

shouldHandle?

optional shouldHandle?: ShouldHandle<OutcomeArgs<T>>

Defined in: src/hedging.ts:46