Class: WebsocketClient

Extends

• BaseWebsocketClient<WsKey, WebsocketSubscription>

Constructors

Constructor

new WebsocketClient(options?: WebsocketClientOptions, logger?: object): WebsocketClient;

Parameters

Parameter	Type	Default value
options?	WebsocketClientOptions	{}
logger?	{ error: (...params: LogParams) => void; info: (...params: LogParams) => void; trace: (..._params: LogParams) => void; }	DefaultLogger
logger.error?	(...params: LogParams) => void	...
logger.info?	(...params: LogParams) => void	...
logger.trace?	(..._params: LogParams) => void	...

Returns

WebsocketClient

Overrides

BaseWebsocketClient<WsKey, WebsocketSubscription>.constructor

Methods

addListener()

addListener<K extends keyof WebsocketClientEventMap<WsKey>>(event: K, listener: (...args: WebsocketClientEventMap<WsKey>[K]) => void): this;

Type Parameters

Type Parameter
K extends keyof WebsocketClientEventMap<WsKey>

Parameters

Parameter	Type
event	K
listener	(...args: WebsocketClientEventMap<WsKey>[K]) => void

Returns

this

Inherited from

BaseWebsocketClient.addListener

---

close()

close(wsKey?: WsKey): void;

Reject pending work immediately; emit 'close' when the socket confirms closure.

Parameters

Parameter	Type
wsKey?	WsKey

Returns

void

---

closeAll()

closeAll(): void;

Returns

void

See

Shut down cleanly

Inherited from

BaseWebsocketClient.closeAll

---

connect()

connect(wsKey?: WsKey): Promise<void>;

Parameters

Parameter	Type	Default value
wsKey?	WsKey	'public'

Returns

Promise<void>

---

connectAll()

connectAll(): Promise<void>;

Connect all cached connection groups, or the public connection if none exist.

Returns

Promise<void>

---

emit()

emit<K extends keyof WebsocketClientEventMap<WsKey>>(event: K, ...args: WebsocketClientEventMap<WsKey>[K]): boolean;

Type Parameters

Type Parameter
K extends keyof WebsocketClientEventMap<WsKey>

Parameters

Parameter	Type
event	K
...args	WebsocketClientEventMap<WsKey>[K]

Returns

boolean

Inherited from

BaseWebsocketClient.emit

---

eventNames()

eventNames(): (keyof WebsocketClientEventMap<WsKey>)[];

Returns

(keyof WebsocketClientEventMap<WsKey>)[]

Inherited from

BaseWebsocketClient.eventNames

---

getMaxListeners()

getMaxListeners(): number;

Returns

number

Inherited from

BaseWebsocketClient.getMaxListeners

---

isConnected()

isConnected(wsKey?: WsKey): boolean;

Parameters

Parameter	Type	Default value
wsKey?	WsKey	'public'

Returns

boolean

---

listenerCount()

listenerCount<K extends keyof WebsocketClientEventMap<WsKey>>(event: K, listener?: (...args: WebsocketClientEventMap<WsKey>[K]) => void): number;

Type Parameters

Type Parameter
K extends keyof WebsocketClientEventMap<WsKey>

Parameters

Parameter	Type
event	K
listener?	(...args: WebsocketClientEventMap<WsKey>[K]) => void

Returns

number

Inherited from

BaseWebsocketClient.listenerCount

---

listeners()

listeners<K extends keyof WebsocketClientEventMap<WsKey>>(event: K): ((...args: WebsocketClientEventMap<WsKey>[K]) => void)[];

Type Parameters

Type Parameter
K extends keyof WebsocketClientEventMap<WsKey>

Parameters

Parameter	Type
event	K

Returns

((...args: WebsocketClientEventMap<WsKey>[K]) => void)[]

Inherited from

BaseWebsocketClient.listeners

---

nameToCoin()

nameToCoin(name: string): Promise<string>;

Parameters

Parameter	Type
name	string

Returns

Promise<string>

---

off()

off<K extends keyof WebsocketClientEventMap<WsKey>>(event: K, listener: (...args: WebsocketClientEventMap<WsKey>[K]) => void): this;

Type Parameters

Type Parameter
K extends keyof WebsocketClientEventMap<WsKey>

Parameters

Parameter	Type
event	K
listener	(...args: WebsocketClientEventMap<WsKey>[K]) => void

Returns

this

Inherited from

BaseWebsocketClient.off

---

on()

on<K extends keyof WebsocketClientEventMap<WsKey>>(event: K, listener: (...args: WebsocketClientEventMap<WsKey>[K]) => void): this;

Type Parameters

Type Parameter
K extends keyof WebsocketClientEventMap<WsKey>

Parameters

Parameter	Type
event	K
listener	(...args: WebsocketClientEventMap<WsKey>[K]) => void

Returns

this

Inherited from

BaseWebsocketClient.on

---

once()

once<K extends keyof WebsocketClientEventMap<WsKey>>(event: K, listener: (...args: WebsocketClientEventMap<WsKey>[K]) => void): this;

Type Parameters

Type Parameter
K extends keyof WebsocketClientEventMap<WsKey>

Parameters

Parameter	Type
event	K
listener	(...args: WebsocketClientEventMap<WsKey>[K]) => void

Returns

this

Inherited from

BaseWebsocketClient.once

---

prependListener()

prependListener<K extends keyof WebsocketClientEventMap<WsKey>>(event: K, listener: (...args: WebsocketClientEventMap<WsKey>[K]) => void): this;

Type Parameters

Type Parameter
K extends keyof WebsocketClientEventMap<WsKey>

Parameters

Parameter	Type
event	K
listener	(...args: WebsocketClientEventMap<WsKey>[K]) => void

Returns

this

Inherited from

BaseWebsocketClient.prependListener

---

prependOnceListener()

prependOnceListener<K extends keyof WebsocketClientEventMap<WsKey>>(event: K, listener: (...args: WebsocketClientEventMap<WsKey>[K]) => void): this;

Type Parameters

Type Parameter
K extends keyof WebsocketClientEventMap<WsKey>

Parameters

Parameter	Type
event	K
listener	(...args: WebsocketClientEventMap<WsKey>[K]) => void

Returns

this

Inherited from

BaseWebsocketClient.prependOnceListener

---

rawListeners()

rawListeners<K extends keyof WebsocketClientEventMap<WsKey>>(event: K): ((...args: WebsocketClientEventMap<WsKey>[K]) => void)[];

Type Parameters

Type Parameter
K extends keyof WebsocketClientEventMap<WsKey>

Parameters

Parameter	Type
event	K

Returns

((...args: WebsocketClientEventMap<WsKey>[K]) => void)[]

Inherited from

BaseWebsocketClient.rawListeners

---

refreshAssetMetadata()

refreshAssetMetadata(): Promise<void>;

Returns

Promise<void>

---

removeAllListeners()

removeAllListeners(event?: keyof WebsocketClientEventMap<WsKey>): this;

Parameters

Parameter	Type
event?	keyof WebsocketClientEventMap<WsKey>

Returns

this

Inherited from

BaseWebsocketClient.removeAllListeners

---

removeListener()

removeListener<K extends keyof WebsocketClientEventMap<WsKey>>(event: K, listener: (...args: WebsocketClientEventMap<WsKey>[K]) => void): this;

Type Parameters

Type Parameter
K extends keyof WebsocketClientEventMap<WsKey>

Parameters

Parameter	Type
event	K
listener	(...args: WebsocketClientEventMap<WsKey>[K]) => void

Returns

this

Inherited from

BaseWebsocketClient.removeListener

---

resolveAsset()

resolveAsset(identifier: string | number): Promise<ResolvedAsset>;

Parameters

Parameter	Type
identifier	string | number

Returns

Promise<ResolvedAsset>

---

sendWSAPIRequest()

sendWSAPIRequest<T>(
   endpoint: "info" | "action", 
   body: unknown, 
   options?: RequestOptions
): Promise<T>;

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
endpoint	"info" | "action"
body	unknown
options?	RequestOptions

Returns

Promise<T>

---

setMaxListeners()

setMaxListeners(count: number): this;

Parameters

Parameter	Type
count	number

Returns

this

Inherited from

BaseWebsocketClient.setMaxListeners

---

subscribe()

subscribe(subscriptions: 
  | WebsocketSubscription
| readonly WebsocketSubscription[]): Promise<void>;

Subscribe to one or more wire topics. Listen for data with on('message'). Topics are cached before connecting and restored automatically after reconnect. The promise confirms local sending; server acknowledgements emit 'response'. Resolve display aliases explicitly with nameToCoin() when needed.

Parameters

Parameter	Type
subscriptions	| WebsocketSubscription | readonly WebsocketSubscription[]

Returns

Promise<void>

See

Subscribe to market data

---

unsubscribe()

unsubscribe(subscriptions: 
  | WebsocketSubscription
| readonly WebsocketSubscription[]): Promise<void>;

Remove cached topics independently of event listeners, including while disconnected.

Parameters

Parameter	Type
subscriptions	| WebsocketSubscription | readonly WebsocketSubscription[]

Returns

Promise<void>