Class BetterWs

Helper Class for simplifying the websocket connection to Discord.

Hierarchy

<internal>.EventEmitter
- BetterWs

Constructors

constructor

new BetterWs(address: string, options: IClientWSOptions): BetterWs

Inherited from EventEmitter.constructor
- Defined in node_modules/cloudstorm/dist/structures/BetterWs.d.ts:39
Parameters
- address: string
- options: IClientWSOptions
Returns BetterWs

Properties

Private _connecting

_connecting: any

Private _internal

_internal: any

Private _onClose

_onClose: any

Private _onError

_onError: any

Private _onReadable

_onReadable: any

Private _processFrame

_processFrame: any

Private _socket

_socket: any

Private _write

_write: any

address

address: string

compress

compress: boolean

encoding

encoding: "json" | "etf"

options

options: IClientWSOptions

presenceBucket

presenceBucket: RatelimitBucket

wsBucket

wsBucket: RatelimitBucket

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

status

get status(): 1 | 2 | 3 | 4

- Defined in node_modules/cloudstorm/dist/structures/BetterWs.d.ts:40
Returns 1 | 2 | 3 | 4

Methods

addListener

addListener<E>(event: E, listener: ((...args: BWSEvents[E]) => any)): BetterWs

Inherited from EventEmitter.addListener
- Defined in node_modules/cloudstorm/dist/structures/BetterWs.d.ts:12
Type Parameters
- E extends keyof BWSEvents
Parameters
- event: E
- listener: ((...args: BWSEvents[E]) => any)
  - - (...args: BWSEvents[E]): any
    - Parameters
      - Rest ...args: BWSEvents[E]
      Returns any
Returns BetterWs

close

close(code: number, reason?: string): Promise<void>

- Defined in node_modules/cloudstorm/dist/structures/BetterWs.d.ts:42
Parameters
- code: number
- Optional reason: string
Returns Promise<void>

connect

connect(): Promise<void>

- Defined in node_modules/cloudstorm/dist/structures/BetterWs.d.ts:41
Returns Promise<void>

emit

emit<E>(event: E, ...args: BWSEvents[E]): boolean

Inherited from EventEmitter.emit
- Defined in node_modules/cloudstorm/dist/structures/BetterWs.d.ts:13
Type Parameters
- E extends keyof BWSEvents
Parameters
- event: E
- Rest ...args: BWSEvents[E]
Returns boolean

eventNames

eventNames(): (keyof BWSEvents)[]

Inherited from EventEmitter.eventNames
- Defined in node_modules/cloudstorm/dist/structures/BetterWs.d.ts:14
Returns (keyof BWSEvents)[]

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:20
Returns number

listenerCount

listenerCount(event: keyof BWSEvents): number

Inherited from EventEmitter.listenerCount
- Defined in node_modules/cloudstorm/dist/structures/BetterWs.d.ts:15
Parameters
- event: keyof BWSEvents
Returns number

listeners

listeners(event: keyof BWSEvents): ((...args: any[]) => any)[]

Inherited from EventEmitter.listeners
- Defined in node_modules/cloudstorm/dist/structures/BetterWs.d.ts:16
Parameters
- event: keyof BWSEvents
Returns ((...args: any[]) => any)[]

off

off<E>(event: E, listener: ((...args: BWSEvents[E]) => any)): BetterWs

Inherited from EventEmitter.off
- Defined in node_modules/cloudstorm/dist/structures/BetterWs.d.ts:17
Type Parameters
- E extends keyof BWSEvents
Parameters
- event: E
- listener: ((...args: BWSEvents[E]) => any)
  - - (...args: BWSEvents[E]): any
    - Parameters
      - Rest ...args: BWSEvents[E]
      Returns any
Returns BetterWs

on

on<E>(event: E, listener: ((...args: BWSEvents[E]) => any)): BetterWs

Inherited from EventEmitter.on
- Defined in node_modules/cloudstorm/dist/structures/BetterWs.d.ts:18
Type Parameters
- E extends keyof BWSEvents
Parameters
- event: E
- listener: ((...args: BWSEvents[E]) => any)
  - - (...args: BWSEvents[E]): any
    - Parameters
      - Rest ...args: BWSEvents[E]
      Returns any
Returns BetterWs

once

once<E>(event: E, listener: ((...args: BWSEvents[E]) => any)): BetterWs

Inherited from EventEmitter.once
- Defined in node_modules/cloudstorm/dist/structures/BetterWs.d.ts:19
Type Parameters
- E extends keyof BWSEvents
Parameters
- event: E
- listener: ((...args: BWSEvents[E]) => any)
  - - (...args: BWSEvents[E]): any
    - Parameters
      - Rest ...args: BWSEvents[E]
      Returns any
Returns BetterWs

prependListener

prependListener<E>(event: E, listener: ((...args: BWSEvents[E]) => any)): BetterWs

Inherited from EventEmitter.prependListener
- Defined in node_modules/cloudstorm/dist/structures/BetterWs.d.ts:20
Type Parameters
- E extends keyof BWSEvents
Parameters
- event: E
- listener: ((...args: BWSEvents[E]) => any)
  - - (...args: BWSEvents[E]): any
    - Parameters
      - Rest ...args: BWSEvents[E]
      Returns any
Returns BetterWs

prependOnceListener

prependOnceListener<E>(event: E, listener: ((...args: BWSEvents[E]) => any)): BetterWs

Inherited from EventEmitter.prependOnceListener
- Defined in node_modules/cloudstorm/dist/structures/BetterWs.d.ts:21
Type Parameters
- E extends keyof BWSEvents
Parameters
- event: E
- listener: ((...args: BWSEvents[E]) => any)
  - - (...args: BWSEvents[E]): any
    - Parameters
      - Rest ...args: BWSEvents[E]
      Returns any
Returns BetterWs

rawListeners

rawListeners(event: keyof BWSEvents): ((...args: any[]) => any)[]

Inherited from EventEmitter.rawListeners
- Defined in node_modules/cloudstorm/dist/structures/BetterWs.d.ts:22
Parameters
- event: keyof BWSEvents
Returns ((...args: any[]) => any)[]

removeAllListeners

removeAllListeners(event?: keyof BWSEvents): BetterWs

Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/cloudstorm/dist/structures/BetterWs.d.ts:23
Parameters
- Optional event: keyof BWSEvents
Returns BetterWs

removeListener

removeListener<E>(event: E, listener: ((...args: BWSEvents[E]) => any)): BetterWs

Inherited from EventEmitter.removeListener
- Defined in node_modules/cloudstorm/dist/structures/BetterWs.d.ts:24
Type Parameters
- E extends keyof BWSEvents
Parameters
- event: E
- listener: ((...args: BWSEvents[E]) => any)
  - - (...args: BWSEvents[E]): any
    - Parameters
      - Rest ...args: BWSEvents[E]
      Returns any
Returns BetterWs

sendMessage

sendMessage(data: IWSMessage): Promise<void>

- Defined in node_modules/cloudstorm/dist/structures/BetterWs.d.ts:43
Parameters
- data: IWSMessage
Returns Promise<void>

setMaxListeners

setMaxListeners(n: number): BetterWs

Inherited from EventEmitter.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:19
Parameters
- n: number
Returns BetterWs

Static listenerCount

listenerCount(emitter: <internal>.EventEmitter, event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:8
deprecated
since v4.0.0

Parameters
- emitter: <internal>.EventEmitter
- event: string | symbol
Returns number

Generated using TypeDoc