kinetex - v1.0.0-rc.1
    Preparing search index...

    Interface CircuitBreakerConfig

    Full circuit breaker configuration.

    interface CircuitBreakerConfig {
        failureThreshold?: number;
        windowSize?: number;
        resetTimeoutMs?: number;
        successThreshold?: number;
        halfOpenConcurrency?: number;
        failures?: FailureFilter;
        onOpen?: (state: CircuitBreakerState) => void;
        onClose?: (state: CircuitBreakerState) => void;
        onHalfOpen?: (state: CircuitBreakerState) => void;
        onRejected?: (state: CircuitBreakerState) => void;
    }
    Index

    Properties

    failureThreshold? windowSize? resetTimeoutMs? successThreshold? halfOpenConcurrency? failures? onOpen? onClose? onHalfOpen? onRejected?

    Properties

    failureThreshold?: number

    Number of failures in the window before opening the circuit. Default: 5

    windowSize?: number

    Sliding-window size (number of most-recent calls tracked). Set to 0 for consecutive-count mode (any 5 in a row). Default: 10

    resetTimeoutMs?: number

    How long to keep the circuit OPEN before probing (ms). Default: 30_000

    successThreshold?: number

    Number of consecutive successes in HALF_OPEN needed to close. Default: 2

    halfOpenConcurrency?: number

    Maximum in-flight probe requests allowed in HALF_OPEN. Default: 1

    failures?: FailureFilter

    Which error categories count as failures.

    onOpen?: (state: CircuitBreakerState) => void

    Called when the circuit opens.

    onClose?: (state: CircuitBreakerState) => void

    Called when the circuit closes (recovers).

    onHalfOpen?: (state: CircuitBreakerState) => void

    Called when the circuit enters half-open.

    onRejected?: (state: CircuitBreakerState) => void

    Called when a request is rejected due to an open circuit.

    Settings

    Member Visibility

    On This Page

    Properties