Class Vote

A Vote Replicated Data type.

A Vote Replicated Data type allows all nodes an a cluster to vote on a condition, such as whether a user is online.

Hierarchy

Vote

Implements

ReplicatedData

Index

Constructors

constructor

Accessors

Methods

toString

Constructors

constructor

new Vote(): Vote

Returns Vote

Accessors

votesFor

get votesFor(): number

- Defined in src/replicated-data/vote.ts:37
The number of nodes that have voted for this condition.

Returns number

totalVoters

get totalVoters(): number

- Defined in src/replicated-data/vote.ts:44
The total number of nodes that have voted.

Returns number

atLeastOne

get atLeastOne(): boolean

- Defined in src/replicated-data/vote.ts:51
Whether at least one node has voted for this condition.

Returns boolean

majority

get majority(): boolean

- Defined in src/replicated-data/vote.ts:58
Whether a majority of nodes have voted for this condition.

Returns boolean

all

get all(): boolean

- Defined in src/replicated-data/vote.ts:65
Whether all of nodes have voted for this condition.

Returns boolean

vote

get vote(): boolean
set vote(value: boolean): void

- Defined in src/replicated-data/vote.ts:72
Get or set the current node's vote.

Returns boolean
- Defined in src/replicated-data/vote.ts:76
Get or set the current node's vote.

Parameters
- value: boolean
Returns void

Methods

toString

toString(): string

- Defined in src/replicated-data/vote.ts:116
Returns string

Generated using TypeDoc