Class ElectionObserver

Object returned from election.observer() that exposes information about the current election.

Hierarchy

EventEmitter
- ElectionObserver

Index

Constructors

Accessors

Methods

cancel leader on

Constructors

constructor

new ElectionObserver(namespace: Namespace): ElectionObserver
Parameters
- namespace: Namespace
Returns ElectionObserver
Overrides EventEmitter.constructor
- Defined in src/election.ts:33

Accessors

hasLeader

get hasLeader(): boolean
Gets whether the election has any leader.

Returns boolean
- Defined in src/election.ts:24

Methods

cancel

cancel(): Promise<void>
Closes the election observer.

Returns Promise<void>
- Defined in src/election.ts:69

leader

leader(encoding?: BufferEncoding): string | undefined
Returns the currently-elected leader value (passed to campaign() or proclaim()), or undefined if there's no elected leader.
Parameters
- Optionalencoding: BufferEncoding
Returns string | undefined
- Defined in src/election.ts:79
leader(encoding: "buffer"): Buffer<ArrayBufferLike> | undefined
Returns the currently-elected leader value (passed to campaign() or proclaim()), or undefined if there's no elected leader.
Parameters
- encoding: "buffer"
Returns Buffer<ArrayBufferLike> | undefined
- Defined in src/election.ts:85

on

on(event: "change", handler: (value: string | undefined) => void): this
change is fired when the elected value changes. It can be fired with undefined if there's no longer a leader.
Parameters
- event: "change"
- handler: (value: string | undefined) => void
Returns this
Overrides EventEmitter.on
- Defined in src/election.ts:44
on(event: "disconnected", handler: (value: Error) => void): this
disconnected is fired when the underlying watcher is disconnected. Etcd3 will automatically attempt to reconnect in the background. This has the same semantics as the disconnected event on the Watcher.
Parameters
- event: "disconnected"
- handler: (value: Error) => void
Returns this
Overrides EventEmitter.on
- Defined in src/election.ts:51
on(event: "error", handler: (value: Error) => void): this
error is fired if the underlying election watcher experiences an unrecoverable error.
Parameters
- event: "error"
- handler: (value: Error) => void
Returns this
Overrides EventEmitter.on
- Defined in src/election.ts:57