adamant-api / index / WebSocketClient

Class: WebSocketClient

Defined in: src/helpers/wsClient.ts:106

Constructors

Constructor

new WebSocketClient(options): WebSocketClient;

Defined in: src/helpers/wsClient.ts:153

Parameters

Parameter	Type
options	WsOptions

Returns

WebSocketClient

Properties

options

options: WsOptions;

Defined in: src/helpers/wsClient.ts:110

Web socket client options.

Methods

catch()

catch(callback): WebSocketClient;

Defined in: src/helpers/wsClient.ts:367

Sets an error handler for all event handlers.

Parameters

Parameter	Type
callback	ErrorHandler

Returns

WebSocketClient

Example

socket.onMessage(() => throw new Error('catch me'))

socket.catch((error) => {
  console.log(error) // Error: catch me
})

---

chooseNode()

chooseNode(): string;

Defined in: src/helpers/wsClient.ts:600

Chooses fastest or random node based on WsOptions.useFastest option

Returns

string

WebSocket url

---

connect()

connect(): WebSocketClient;

Defined in: src/helpers/wsClient.ts:268

Connects using the current healthy-node list.

Returns

WebSocketClient

---

disconnect()

disconnect(): WebSocketClient;

Defined in: src/helpers/wsClient.ts:289

Disconnects and cancels pending reconnection attempts.

Returns

WebSocketClient

---

fastestNode()

fastestNode(): ActiveNode;

Defined in: src/helpers/wsClient.ts:618

Returns

ActiveNode

---

off()

off(handler): WebSocketClient;

Defined in: src/helpers/wsClient.ts:387

Removes the handler from all types.

Parameters

Parameter	Type
handler	SingleTransactionHandler

Returns

WebSocketClient

---

on()

Call Signature

on(handler): this;

Defined in: src/helpers/wsClient.ts:405

Adds an event listener handler for all transaction types.

Parameters

Parameter	Type
handler	AnyTransactionHandler

Returns

this

Call Signature

on<T>(types, handler): this;

Defined in: src/helpers/wsClient.ts:409

Adds an event listener handler for the specific transaction types.

Type Parameters

Type Parameter
T extends keyof TransactionMap

Parameters

Parameter	Type
types	T | T[]
handler	TransactionHandler<TransactionMap[T]>

Returns

this

---

onChatMessage()

onChatMessage(handler): WebSocketClient;

Defined in: src/helpers/wsClient.ts:465

Registers a handler for plain chat messages.

Parameters

Parameter	Type
handler	TransactionHandler<ChatMessageTransaction>

Returns

WebSocketClient

---

onConnection()

onConnection(callback): WebSocketClient;

Defined in: src/helpers/wsClient.ts:373

Registers a callback for the first successful connection.

Parameters

Parameter	Type
callback	ConnectionHandler

Returns

WebSocketClient

---

onKVS()

onKVS(handler): WebSocketClient;

Defined in: src/helpers/wsClient.ts:507

Registers an event handler for Key-Value Store (KVS) transactions.

Parameters

Parameter	Type
handler	TransactionHandler<KVSTransaction>

Returns

WebSocketClient

---

onMessage()

Call Signature

onMessage(handler): this;

Defined in: src/helpers/wsClient.ts:439

Registers an event handler for Chat Message transactions.

Parameters

Parameter	Type
handler	TransactionHandler<ChatMessageTransaction>

Returns

this

Call Signature

onMessage(messageTypes, handler): this;

Defined in: src/helpers/wsClient.ts:440

Registers an event handler for Chat Message transactions.

Parameters

Parameter	Type
messageTypes	| MessageType | MessageType[]
handler	TransactionHandler<ChatMessageTransaction>

Returns

this

---

onNewDelegate()

onNewDelegate(handler): WebSocketClient;

Defined in: src/helpers/wsClient.ts:489

Registers an event handler for Register Delegate transactions.

Parameters

Parameter	Type
handler	TransactionHandler<RegisterDelegateTransaction>

Returns

WebSocketClient

---

onReconnection()

onReconnection(callback): WebSocketClient;

Defined in: src/helpers/wsClient.ts:379

Registers a callback for successful reconnections.

Parameters

Parameter	Type
callback	ConnectionHandler

Returns

WebSocketClient

---

onRichMessage()

onRichMessage(handler): WebSocketClient;

Defined in: src/helpers/wsClient.ts:470

Registers a handler for rich messages.

Parameters

Parameter	Type
handler	TransactionHandler<ChatMessageTransaction>

Returns

WebSocketClient

---

onSignalMessage()

onSignalMessage(handler): WebSocketClient;

Defined in: src/helpers/wsClient.ts:475

Registers a handler for signal messages.

Parameters

Parameter	Type
handler	TransactionHandler<ChatMessageTransaction>

Returns

WebSocketClient

---

onTransfer()

onTransfer(handler): WebSocketClient;

Defined in: src/helpers/wsClient.ts:482

Registers an event handler for Token Transfer transactions.

Parameters

Parameter	Type
handler	TransactionHandler<TokenTransferTransaction>

Returns

WebSocketClient

---

onVoteForDelegate()

onVoteForDelegate(handler): WebSocketClient;

Defined in: src/helpers/wsClient.ts:498

Registers an event handler for Vote for Delegate transactions.

Parameters

Parameter	Type
handler	TransactionHandler<VoteForDelegateTransaction>

Returns

WebSocketClient

---

randomNode()

randomNode(): ActiveNode;

Defined in: src/helpers/wsClient.ts:622

Returns

ActiveNode

---

reviseConnection()

reviseConnection(nodes): void;

Defined in: src/helpers/wsClient.ts:192

Filters nodes that support websocket and connects to one of them.

Parameters

Parameter	Type	Description
nodes	ActiveNode[]	Sorted by ping array of active nodes

Returns

void

---

setConnection()

setConnection(): void;

Defined in: src/helpers/wsClient.ts:213

Chooses node and sets up connection.

Returns

void