Class EventClient<T>

Simple wrapper around the Revolt websocket service.

Type Parameters

T extends AvailableProtocols

Hierarchy

EventEmitter<Events<T, EventProtocol<T>>>
- EventClient

Index

Constructors

constructor

new EventClient<T>(protocolVersion, transportFormat?, options?): EventClient<T>
Create a new event client.
Type Parameters
- T extends 1
Parameters
- protocolVersion: T
  
  Target protocol version
- transportFormat: "json" = "json"
  
  Communication format
- Optional options: Partial<EventClientOptions>
  
  Configuration options
Returns EventClient<T>
Overrides EventEmitter< Events<T, EventProtocol<T>> >.constructor
- Defined in src/events/EventClient.ts:88

Properties

`Private` #connectTimeoutReference

#connectTimeoutReference: undefined | number

`Private` #heartbeatIntervalReference

#heartbeatIntervalReference: undefined | number

`Private` #lastError

#lastError: undefined | {
    data: any;
    type: "socket";
} | {
    data: Object;
    type: "revolt";
}

Type declaration

data: any
type: "socket"

Type declaration

data: Object
type: "revolt"

`Private` #pongTimeoutReference

#pongTimeoutReference: undefined | number

`Private` #protocolVersion

#protocolVersion: T

`Private` #setPing

#setPing: Setter<number>

`Private` #setStateSetter

#setStateSetter: Setter<ConnectionState>

`Private` #socket

#socket: undefined | WebSocket

`Private` #transportFormat

#transportFormat: "json" | "msgpack"

`Readonly` options

options: EventClientOptions

`Readonly` ping

ping: Accessor<number>

`Readonly` state

state: Accessor<ConnectionState>

`Static` prefixed

prefixed: string | boolean

Accessors

lastError

get lastError(): undefined | {
    data: any;
    type: "socket";
} | {
    data: Object;
    type: "revolt";
}
Last error encountered by events client

Returns undefined | {
    data: any;
    type: "socket";
} | {
    data: Object;
    type: "revolt";
}
- Defined in src/events/EventClient.ts:261

Methods

addListener

addListener<T>(event, fn, context?): EventClient<T>
Type Parameters
- T extends keyof Events<T, EventProtocol<T>>
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]
      
      Returns void
- Optional context: any
Returns EventClient<T>
Inherited from EventEmitter.addListener
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:45

connect

connect(uri, token): void
Connect to the websocket service.
Parameters
- uri: string
  
  WebSocket URI
- token: string
  
  Authentication token
Returns void
- Defined in src/events/EventClient.ts:131

disconnect

disconnect(): void
Disconnect the websocket client.

Returns void
- Defined in src/events/EventClient.ts:185

emit

emit<T>(event, ...args): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends keyof Events<T, EventProtocol<T>>
Parameters
- event: T
- Rest ...args: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]
Returns boolean
Inherited from EventEmitter.emit
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): (keyof Events<T, EventProtocol<T>>)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (keyof Events<T, EventProtocol<T>>)[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:15

handle

handle(event): void
Handle events intended for client before passing them along.
Parameters
- event: EventProtocol<T>["server"]
  
  Event
Returns void
- Defined in src/events/EventClient.ts:209

listenerCount

listenerCount(event): number
Return the number of listeners listening to a given event.
Parameters
- event: keyof Events<T, EventProtocol<T>>
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T>(event): ((...args) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends keyof Events<T, EventProtocol<T>>
Parameters
- event: T
Returns ((...args) => void)[]
Inherited from EventEmitter.listeners
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:20

off

off<T>(event, fn?, context?, once?): EventClient<T>
Type Parameters
- T extends keyof Events<T, EventProtocol<T>>
Parameters
- event: T
- Optional fn: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]
      
      Returns void
- Optional context: any
- Optional once: boolean
Returns EventClient<T>
Inherited from EventEmitter.off
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:69

on

on<T>(event, fn, context?): EventClient<T>
Add a listener for a given event.
Type Parameters
- T extends keyof Events<T, EventProtocol<T>>
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]
      
      Returns void
- Optional context: any
Returns EventClient<T>
Inherited from EventEmitter.on
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:40

once

once<T>(event, fn, context?): EventClient<T>
Add a one-time listener for a given event.
Type Parameters
- T extends keyof Events<T, EventProtocol<T>>
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]
      
      Returns void
- Optional context: any
Returns EventClient<T>
Inherited from EventEmitter.once
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:54

removeAllListeners

removeAllListeners(event?): EventClient<T>
Remove all listeners, or those of the specified event.
Parameters
- Optional event: keyof Events<T, EventProtocol<T>>
Returns EventClient<T>
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T>(event, fn?, context?, once?): EventClient<T>
Remove the listeners of a given event.
Type Parameters
- T extends keyof Events<T, EventProtocol<T>>
Parameters
- event: T
- Optional fn: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]
      
      Returns void
- Optional context: any
- Optional once: boolean
Returns EventClient<T>
Inherited from EventEmitter.removeListener
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:63

send

send(event): void
Send an event to the server.
Parameters
- event: EventProtocol<T>["client"]
  
  Event
Returns void
- Defined in src/events/EventClient.ts:199

`Private` setState

setState(state): void
Set the current state
Parameters
- state: ConnectionState
  
  state
Returns void
- Defined in src/events/EventClient.ts:121

Class EventClient<T>

Type Parameters

T extends AvailableProtocols

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T extends 1

Parameters

protocolVersion: T

transportFormat: "json" = "json"

Optional options: Partial<EventClientOptions>

Returns EventClient<T>

Properties

Private #connectTimeoutReference

Private #heartbeatIntervalReference

Private #lastError

Type declaration

data: any

type: "socket"

Type declaration

data: Object

type: "revolt"

Private #pongTimeoutReference

Private #protocolVersion

Private #setPing

Private #setStateSetter

Private #socket

Private #transportFormat

Readonly options

Readonly ping

Readonly state

Static prefixed

Accessors

lastError

Returns undefined | { data: any; type: "socket"; } | { data: Object; type: "revolt"; }

Methods

addListener

Type Parameters

T extends keyof Events<T, EventProtocol<T>>

Parameters

event: T

fn: ((...args) => void)

Parameters

Rest ...args: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]

Returns void

Optional context: any

Returns EventClient<T>

connect

Parameters

uri: string

token: string

Returns void

disconnect

Returns void

emit

Type Parameters

T extends keyof Events<T, EventProtocol<T>>

Parameters

event: T

Rest ...args: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]

Returns boolean

eventNames

Returns (keyof Events<T, EventProtocol<T>>)[]

handle

Parameters

event: EventProtocol<T>["server"]

Returns void

listenerCount

Parameters

event: keyof Events<T, EventProtocol<T>>

Returns number

listeners

Type Parameters

T extends keyof Events<T, EventProtocol<T>>

`Optional` options: Partial<EventClientOptions>

`Private` #connectTimeoutReference

`Private` #heartbeatIntervalReference

`Private` #lastError

`Private` #pongTimeoutReference

`Private` #protocolVersion

`Private` #setPing

`Private` #setStateSetter

`Private` #socket

`Private` #transportFormat

`Readonly` options

`Readonly` ping

`Readonly` state

`Static` prefixed

Returns undefined | {
data: any;
type: "socket";
} | {
data: Object;
type: "revolt";
}

`Rest` ...args: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]

`Optional` context: any

`Rest` ...args: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]

`Optional` fn: ((...args) => void)

`Rest` ...args: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]

`Optional` context: any

`Optional` once: boolean

`Rest` ...args: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]

`Optional` context: any

`Rest` ...args: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]

`Optional` context: any

`Optional` event: keyof Events<T, EventProtocol<T>>

`Optional` fn: ((...args) => void)

`Rest` ...args: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]

`Optional` context: any

`Optional` once: boolean

`Private` setState