CircuitBreakerOptionsBuilder

Defined in: src/pattern/CircuitBreakerOptions.ts:23

Fluent builder for CircuitBreakerOptionsType:

new CircuitBreaker(CircuitBreakerOptions.create()
  .withMaxFailures(5)
  .withResetTimeoutMs(10_000));

Extends

• OptionsBuilder<CircuitBreakerOptionsType>

Constructors

Constructor

new CircuitBreakerOptionsBuilder(): CircuitBreakerOptionsBuilder

Returns

CircuitBreakerOptionsBuilder

Inherited from

OptionsBuilder.constructor

Methods

build()

build(): Partial<T>

Defined in: src/util/OptionsBuilder.ts:51

Snapshot the set fields as an independent Partial<T> (own props only).

Returns

Partial<T>

Inherited from

OptionsBuilder.build

---

withCallTimeoutMs()

withCallTimeoutMs(callTimeoutMs): this

Defined in: src/pattern/CircuitBreakerOptions.ts:40

Per-call timeout; exceeding it counts as a failure.

Parameters

callTimeoutMs

number

Returns

this

---

withIsFailure()

withIsFailure(isFailure): this

Defined in: src/pattern/CircuitBreakerOptions.ts:45

Classify errors as non-failures to bypass breaker counting.

Parameters

isFailure

(err) => boolean

Returns

this

---

withMaxFailures()

withMaxFailures(maxFailures): this

Defined in: src/pattern/CircuitBreakerOptions.ts:30

Consecutive failures before the breaker opens. Must be >= 1.

Parameters

maxFailures

number

Returns

this

---

withResetTimeoutMs()

withResetTimeoutMs(resetTimeoutMs): this

Defined in: src/pattern/CircuitBreakerOptions.ts:35

How long the breaker stays open before letting a probe through (ms).

Parameters

resetTimeoutMs

number

Returns

this

---

create()

static create(): CircuitBreakerOptionsBuilder

Defined in: src/pattern/CircuitBreakerOptions.ts:25

Start a fresh builder.

Returns

CircuitBreakerOptionsBuilder