StableObservationOptionsBuilder

Defined in: src/cluster/bootstrap/StableObservationOptions.ts:91

Fluent builder for StableObservationOptionsType.

const observationOptions = StableObservationOptions.create()
  .withSeedProvider(seedProvider)
  .withSelfAddress(selfAddress)
  .withRequiredContactPoints(3);
const observation = new StableObservation(observationOptions);

Extends

• OptionsBuilder<StableObservationOptionsType>

Constructors

Constructor

new StableObservationOptionsBuilder(): StableObservationOptionsBuilder

Returns

StableObservationOptionsBuilder

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

---

withLog()

withLog(log): this

Defined in: src/cluster/bootstrap/StableObservationOptions.ts:133

Where progress and reset lines go. Default: discarded.

Parameters

log

(message) => void

Returns

this

---

withMaxWaitMs()

withMaxWaitMs(ms): this

Defined in: src/cluster/bootstrap/StableObservationOptions.ts:118

Total budget before the observation throws. Default: 60 000 ms.

Parameters

ms

number

Returns

this

---

withPollIntervalMs()

withPollIntervalMs(ms): this

Defined in: src/cluster/bootstrap/StableObservationOptions.ts:113

Cadence of the lookup() polls. Default: 1 000 ms.

Parameters

ms

number

Returns

this

---

withRequiredContactPoints()

withRequiredContactPoints(count): this

Defined in: src/cluster/bootstrap/StableObservationOptions.ts:123

Fewest contact points a stable observation may contain. Default: 1.

Parameters

count

number

Returns

this

---

withSeedProvider()

withSeedProvider(seedProvider): this

Defined in: src/cluster/bootstrap/StableObservationOptions.ts:98

Where the contact points come from.

Parameters

seedProvider

SeedProvider

Returns

this

---

withSelfAddress()

withSelfAddress(selfAddress): this

Defined in: src/cluster/bootstrap/StableObservationOptions.ts:103

This node’s advertised address — the value the election orders on.

Parameters

selfAddress

NodeAddress

Returns

this

---

withSelfElectionGraceMs()

withSelfElectionGraceMs(ms): this

Defined in: src/cluster/bootstrap/StableObservationOptions.ts:128

Grace handed to the elected initial seed. Default: 10 000 ms.

Parameters

ms

number

Returns

this

---

withStableMarginMs()

withStableMarginMs(ms): this

Defined in: src/cluster/bootstrap/StableObservationOptions.ts:108

How long the observed set must stay unchanged. Default: 5 000 ms.

Parameters

ms

number

Returns

this

---

create()

static create(): StableObservationOptionsBuilder

Defined in: src/cluster/bootstrap/StableObservationOptions.ts:93

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

Returns

StableObservationOptionsBuilder