@eveble/eveble
Hierarchy
Stateful
↳ Client
Implemented by
Index
Properties
Methods
- connect
- disconnect
- getId
- getSelectableStates
- getState
- hasState
- initialize
- isConnected
- isInOneOfStates
- isInState
- reconnect
- setState
- validateState
Properties
state
• state: State
Overrides void
Methods
connect
▸ connect(): Promise‹void›
Returns: Promise‹void›
▸ connect(): Promise‹void›
Returns: Promise‹void›
disconnect
▸ disconnect(): Promise‹void›
Returns: Promise‹void›
▸ disconnect(): Promise‹void›
Returns: Promise‹void›
getId
▸ getId(): string | Stringifiable
Returns: string | Stringifiable
▸ getId(): string | Stringifiable
Returns: string | Stringifiable
getSelectableStates
▸ getSelectableStates(): Record‹string, State›
Inherited from Stateful.getSelectableStates
Overrides void
Returns: Record‹string, State›
getState
▸ getState(): State
Inherited from Stateful.getState
Overrides void
Returns: State
hasState
▸ hasState(): boolean
Inherited from Stateful.hasState
Overrides void
Returns: boolean
initialize
▸ initialize(): Promise‹void›
Returns: Promise‹void›
▸ initialize(): Promise‹void›
Returns: Promise‹void›
isConnected
▸ isConnected(): boolean
Returns: boolean
▸ isConnected(): boolean
Returns: boolean
isInOneOfStates
▸ isInOneOfStates(states
: State | State[]): boolean
Inherited from Stateful.isInOneOfStates
Overrides void
Parameters:
Name | Type |
---|---|
states | State | State[] |
Returns: boolean
isInState
▸ isInState(state
: State | State[]): boolean
Inherited from Stateful.isInState
Overrides void
Parameters:
Name | Type |
---|---|
state | State | State[] |
Returns: boolean
reconnect
▸ reconnect(): Promise‹void›
Returns: Promise‹void›
▸ reconnect(): Promise‹void›
Returns: Promise‹void›
setState
▸ setState(state
: State): void
Inherited from Stateful.setState
Overrides void
Parameters:
Name | Type |
---|---|
state | State |
Returns: void
validateState
▸ validateState(stateOrStates
: State | State[], error?
: Error): boolean
Inherited from Stateful.validateState
Overrides void
Parameters:
Name | Type |
---|---|
stateOrStates | State | State[] |
error? | Error |
Returns: boolean