WsHandler.md

mewbot / WsHandler

Class: WsHandler

Hierarchy

• BaseEmitter<{ open: void ; dispatch: Dispatch ; close: void }>

  ↳ WsHandler

Table of contents

Constructors

• constructor

Properties

• _emitter
• _ws
• _connectStatus
• _heartbeatCheck

Methods

• on
• off
• emit
• connect
• retryConnection
• checkHeartbeat
• parseDispatch
• refineDispatch
• close

Constructors

constructor

• new WsHandler()

Inherited from

BaseEmitter<{ open: void, dispatch: Dispatch, close: void, }>.constructor

Properties

_emitter

• Protected _emitter: EventEmitter

Inherited from

BaseEmitter._emitter

---

_ws

• Protected _ws: WebSocket

---

_connectStatus

• Protected _connectStatus: ConnectStatus = ConnectStatus.None

---

_heartbeatCheck

• Protected _heartbeatCheck: number = -1

Methods

on

▸ on<K>(eventName, fn): void

Type parameters

Name	Type
K	extends EventKey<{ open: void ; dispatch: Dispatch ; close: void }>

Parameters

Name	Type
eventName	K
fn	EventReceiver<{ open: void ; dispatch: Dispatch ; close: void }[K]>

Returns

void

Inherited from

BaseEmitter.on

---

off

▸ off<K>(eventName, fn): void

Type parameters

Name	Type
K	extends EventKey<{ open: void ; dispatch: Dispatch ; close: void }>

Parameters

Name	Type
eventName	K
fn	EventReceiver<{ open: void ; dispatch: Dispatch ; close: void }[K]>

Returns

void

Inherited from

BaseEmitter.off

---

emit

▸ Protected emit<K>(eventName, params): void

Type parameters

Name	Type
K	extends EventKey<{ open: void ; dispatch: Dispatch ; close: void }>

Parameters

Name	Type
eventName	K
params	{ open: void ; dispatch: Dispatch ; close: void }[K]

Returns

void

Inherited from

BaseEmitter.emit

---

connect

▸ connect(options, auth?): void

Parameters

Name	Type
options	Partial<ConnectOptions>
auth?	Auth

Returns

void

---

retryConnection

▸ Protected retryConnection(options): void

Parameters

Name	Type
options	ConnectOptions

Returns

void

---

checkHeartbeat

▸ Protected checkHeartbeat(options, timeout?): void

Parameters

Name	Type	Default value
options	ConnectOptions	undefined
timeout	number	0

Returns

void

---

parseDispatch

▸ Protected parseDispatch(raw): Dispatch

Parameters

Name	Type
raw	string

Returns

Dispatch

---

refineDispatch

▸ Protected refineDispatch(raw): void

Parameters

Name	Type
raw	Dispatch

Returns

void

---

close

▸ close(): void

Returns

void