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: T, transportFormat?: "json", options?: Partial<EventClientOptions>): 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:77

Properties

`Private` #heartbeatIntervalReference

#heartbeatIntervalReference: undefined | number

`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

Methods

addListener

addListener<T>(event: T, fn: ((...args: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]) => void), context?: any): EventClient<T>
Type Parameters
- T extends keyof Events<T, EventProtocol<T>>
Parameters
- event: T
- fn: ((...args: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]) => void)
  - - (...args: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]): 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.0/node_modules/eventemitter3/index.d.ts:45

connect

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

disconnect

disconnect(): void
Disconnect the websocket client.

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

emit

emit<T>(event: T, ...args: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]): 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.0/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.0/node_modules/eventemitter3/index.d.ts:15

handle

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

listenerCount

listenerCount(event: keyof Events<T, EventProtocol<T>>): 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.0/node_modules/eventemitter3/index.d.ts:27

listeners

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

off

off<T>(event: T, fn?: ((...args: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]) => void), context?: any, once?: boolean): EventClient<T>
Type Parameters
- T extends keyof Events<T, EventProtocol<T>>
Parameters
- event: T
- Optional fn: ((...args: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]) => void)
  - - (...args: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]): 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.0/node_modules/eventemitter3/index.d.ts:69

on

on<T>(event: T, fn: ((...args: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]) => void), context?: any): EventClient<T>
Add a listener for a given event.
Type Parameters
- T extends keyof Events<T, EventProtocol<T>>
Parameters
- event: T
- fn: ((...args: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]) => void)
  - - (...args: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]): 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.0/node_modules/eventemitter3/index.d.ts:40

once

once<T>(event: T, fn: ((...args: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]) => void), context?: any): 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: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]) => void)
  - - (...args: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]): 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.0/node_modules/eventemitter3/index.d.ts:54

removeAllListeners

removeAllListeners(event?: keyof Events<T, EventProtocol<T>>): 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.0/node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T>(event: T, fn?: ((...args: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]) => void), context?: any, once?: boolean): EventClient<T>
Remove the listeners of a given event.
Type Parameters
- T extends keyof Events<T, EventProtocol<T>>
Parameters
- event: T
- Optional fn: ((...args: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]) => void)
  - - (...args: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]): 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.0/node_modules/eventemitter3/index.d.ts:63

send

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

`Private` setState

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

Class EventClient<T>

Type Parameters

T extends AvailableProtocols

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T extends 1

Parameters

protocolVersion: T

transportFormat: "json" = "json"

Optional options: Partial<EventClientOptions>

Returns EventClient<T>

Properties

Private #heartbeatIntervalReference

Private #pongTimeoutReference

Private #protocolVersion

Private #setPing

Private #setStateSetter

Private #socket

Private #transportFormat

Readonly options

Readonly ping

Readonly state

Static prefixed

Methods

addListener

Type Parameters

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

Parameters

event: T

fn: ((...args: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]) => 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>>

Parameters

event: T

Returns ((...args: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]) => void)[]

off

Type Parameters

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

Parameters

event: T

Optional fn: ((...args: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]) => void)

Parameters

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

Returns void

`Optional` options: Partial<EventClientOptions>

`Private` #heartbeatIntervalReference

`Private` #pongTimeoutReference

`Private` #protocolVersion

`Private` #setPing

`Private` #setStateSetter

`Private` #socket

`Private` #transportFormat

`Readonly` options

`Readonly` ping

`Readonly` state

`Static` prefixed

`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: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]) => 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: ArgumentMap<Events<T, EventProtocol<T>>>[Extract<T, keyof Events<T, EventProtocol<T>>>]) => void)

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

`Optional` context: any

`Optional` once: boolean

`Private` setState