CircuitBreakerConfig

Defined in: packages/gateway/src/policies/resilience/circuit-breaker.ts:139

Base configuration shared by all policies

Extends

• PolicyConfig

Properties

failureOn?

optional failureOn?: number[]

Defined in: packages/gateway/src/policies/resilience/circuit-breaker.ts:147

Status codes considered failures. Default: [500, 502, 503, 504].

---

failureThreshold?

optional failureThreshold?: number

Defined in: packages/gateway/src/policies/resilience/circuit-breaker.ts:141

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

---

halfOpenMax?

optional halfOpenMax?: number

Defined in: packages/gateway/src/policies/resilience/circuit-breaker.ts:145

Max concurrent probes allowed in half-open state. Default: 1.

---

key?

optional key?: (c) => string

Defined in: packages/gateway/src/policies/resilience/circuit-breaker.ts:151

Key extractor. Default: request URL pathname.

Parameters

c

Context

Returns

string

---

onStateChange?

optional onStateChange?: (key, from, to) => void | Promise<void>

Defined in: packages/gateway/src/policies/resilience/circuit-breaker.ts:164

Callback invoked on every state transition.

Called via safeCall so errors are swallowed - a failing callback never blocks traffic. Useful for metrics, logging, or alerting.

Parameters

key

string

The circuit key that transitioned.

from

CircuitState

The previous circuit state.

to

CircuitState

The new circuit state.

Returns

void | Promise<void>

---

openStatusCode?

optional openStatusCode?: number

Defined in: packages/gateway/src/policies/resilience/circuit-breaker.ts:153

HTTP status code when the circuit is open. Default: 503.

---

resetTimeoutMs?

optional resetTimeoutMs?: number

Defined in: packages/gateway/src/policies/resilience/circuit-breaker.ts:143

Time in ms before transitioning from open → half-open. Default: 30000.

---

skip?

optional skip?: (c) => boolean | Promise<boolean>

Defined in: packages/gateway/src/policies/types.ts:90

Skip this policy when condition returns true

Parameters

c

unknown

Returns

boolean | Promise<boolean>

Inherited from

PolicyConfig.skip

---

store?

optional store?: CircuitBreakerStore

Defined in: packages/gateway/src/policies/resilience/circuit-breaker.ts:149

Storage backend. Default: InMemoryCircuitBreakerStore.