Interface ChaosSendFailureOptions

Transient outbound failures.

interface ChaosSendFailureOptions {
    probability?: number;
    attempts?: number[];
    errors?: (ChaosSendErrorKind | ChaosErrorFactory)[];
    retryAfterMs?: number;
    maxConsecutive?: number;
}

Properties

probability?: number

Probability [0, 1] that a send fails. Defaults to 1, or to 0 when attempts is given (scripted failures only).

attempts?: number[]

1-based send attempts that always fail (deterministic script), e.g. [1, 3].

Failure kinds/factories used in order, cycling (1st failure → errors[0], 2nd → errors[1], …). Default ['rate-limited'].

retryAfterMs?: number

retryAfterMs carried by 'rate-limited' failures. Default 1000.

maxConsecutive?: number

Longest streak of probabilistic failures before a send is forced through (keeps failures transient). Default Infinity.