FailureDetectorOptionsBuilder

Defined in: src/cluster/FailureDetectorOptions.ts:29

Fluent builder for FailureDetectorOptionsType. Unset fields fall through to defaultFailureDetectorOptions in the consumer, so a bare FailureDetectorOptions.create() yields the defaults.

new FailureDetector(
  FailureDetectorOptions.create().withUnreachableAfterMs(3_000),
)

Extends

• OptionsBuilder<FailureDetectorOptionsType>

Constructors

Constructor

new FailureDetectorOptionsBuilder(): FailureDetectorOptionsBuilder

Returns

FailureDetectorOptionsBuilder

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

---

withDownAfterMs()

withDownAfterMs(ms): this

Defined in: src/cluster/FailureDetectorOptions.ts:49

Time without heartbeat after which a peer is declared down — measured from the last heartbeat, so it must exceed unreachableAfterMs.

Parameters

ms

number

Returns

this

---

withHeartbeatIntervalMs()

withHeartbeatIntervalMs(ms): this

Defined in: src/cluster/FailureDetectorOptions.ts:36

How often the detector samples and decides membership health.

Parameters

ms

number

Returns

this

---

withUnreachableAfterMs()

withUnreachableAfterMs(ms): this

Defined in: src/cluster/FailureDetectorOptions.ts:41

Time without heartbeat after which a peer is marked unreachable.

Parameters

ms

number

Returns

this

---

create()

static create(): FailureDetectorOptionsBuilder

Defined in: src/cluster/FailureDetectorOptions.ts:31

Start a fresh builder. Equivalent to new FailureDetectorOptionsBuilder().

Returns

FailureDetectorOptionsBuilder