DiscordConnector

Class used for acting based on received events.

This class is automatically instantiated by the library and is documented for reference.

Hierarchy

<internal>.EventEmitter
- DiscordConnector

Constructors

constructor

new DiscordConnector(id: number, client: <internal>.Client): DiscordConnector

Inherited from EventEmitter.constructor
- Defined in node_modules/cloudstorm/dist/connector/DiscordConnector.d.ts:53
Create a new Discord Connector.

Parameters
- id: number
  
  id of the shard that created this class.
- client: <internal>.Client
  
  Main client instance.
Returns DiscordConnector

Properties

Private _checkPresenceData

_checkPresenceData: any

Checks presence data and fills in missing elements.

param data: Data to send.
returns: Data after it's fixed/checked.

Private _checkRequestGuildMembersData

_checkRequestGuildMembersData: any

Checks request guild members data and fills in missing elements.

param data: Data to send.
returns: Data after it's fixed/checked.

Private _checkVoiceStateUpdateData

_checkVoiceStateUpdateData: any

Checks voice state update data and fills in missing elements.

param data: Data to send.
returns: Data after it's fixed/checked.

Private _closing

_closing: any

Private _reconnect

_reconnect: any

Reset this connector to be ready to resume or hard reconnect, then connect.

param resume: Whether or not the client intends to send an OP 6 RESUME later.

_trace

_trace: null | string

betterWs

betterWs: BetterWs

Private clearHeartBeat

clearHeartBeat: any

Clear the heart beat interval, set it to null and set the cached heartbeat_interval as 0.

client

client: <internal>.Client

Private handleDispatch

handleDispatch: any

Handle dispatch events.

param message: Message received from the websocket.

Private handleWsClose

handleWsClose: any

Handle a close from the underlying websocket.

param code: Websocket close code.
param reason: Close reason if any.

Private heartbeat

heartbeat: any

Send an OP 1 HEARTBEAT to the gateway.

heartbeatInterval

heartbeatInterval: number

heartbeatTimeout

heartbeatTimeout: null | Timeout

id

id: number

lastACKAt

lastACKAt: number

lastHeartbeatSend

lastHeartbeatSend: number

latency

latency: number

Private messageAction

messageAction: any

Called with a parsed Websocket message to execute further actions.

param message: Message that was received.

options

options: Omit<IClientOptions, "snowtransferInstance"> & { endpoint?: string; token: string }

reconnect

reconnect: boolean

Private reset

reset: any

Hard reset this connector.

Private resume

resume: any

Send an OP 6 RESUME to the gateway.

seq

seq: number

sessionId

sessionId: null | string

status

status: "ready" | "disconnected" | "connecting" | "identifying" | "resuming"

Static Readonly default

default: typeof DiscordConnector

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

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

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

connect

connect(): Promise<void>

- Defined in node_modules/cloudstorm/dist/connector/DiscordConnector.d.ts:57
Connect to Discord.

Returns Promise<void>

disconnect

disconnect(): Promise<void>

- Defined in node_modules/cloudstorm/dist/connector/DiscordConnector.d.ts:61
Close the websocket connection and disconnect.

Returns Promise<void>

emit

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

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

eventNames

eventNames(): (keyof ConnectorEvents)[]

Inherited from EventEmitter.eventNames
- Defined in node_modules/cloudstorm/dist/connector/DiscordConnector.d.ts:14
Returns (keyof ConnectorEvents)[]

getMaxListeners

getMaxListeners(): number

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

identify

identify(force?: boolean): Promise<void>

- Defined in node_modules/cloudstorm/dist/connector/DiscordConnector.d.ts:84
Send an OP 2 IDENTIFY to the gateway or an OP 6 RESUME if forceful identify is falsy.

Parameters
- Optional force: boolean
  
  Whether CloudStorm should send an OP 2 IDENTIFY even if there's a session that could be resumed.
Returns Promise<void>

listenerCount

listenerCount(event: keyof ConnectorEvents): number

Inherited from EventEmitter.listenerCount
- Defined in node_modules/cloudstorm/dist/connector/DiscordConnector.d.ts:15
Parameters
- event: keyof ConnectorEvents
Returns number

listeners

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

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

off

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

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

on

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

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

once

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

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

prependListener

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

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

prependOnceListener

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

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

presenceUpdate

presenceUpdate(data: <internal>.GatewayPresenceUpdate): Promise<void>

- Defined in node_modules/cloudstorm/dist/connector/DiscordConnector.d.ts:108
Send an OP 3 PRESENCE_UPDATE to the gateway.

Parameters
- data: <internal>.GatewayPresenceUpdate
  
  Presence data to send.
Returns Promise<void>

rawListeners

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

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

removeAllListeners

removeAllListeners(event?: keyof ConnectorEvents): DiscordConnector

Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/cloudstorm/dist/connector/DiscordConnector.d.ts:23
Parameters
- Optional event: keyof ConnectorEvents
Returns DiscordConnector

removeListener

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

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

requestGuildMembers

requestGuildMembers(data: <internal>.GuildRequestMembersPayload & { limit?: number }): Promise<void>

- Defined in node_modules/cloudstorm/dist/connector/DiscordConnector.d.ts:121
Send an OP 8 REQUEST_GUILD_MEMBERS to the gateway.

Parameters
- data: <internal>.GuildRequestMembersPayload & { limit?: number }
  
  Data to send.
Returns Promise<void>

setMaxListeners

setMaxListeners(n: number): DiscordConnector

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

voiceStateUpdate

voiceStateUpdate(data: <internal>.VoiceStateUpdatePayload & { self_deaf?: boolean; self_mute?: boolean }): Promise<void>

- Defined in node_modules/cloudstorm/dist/connector/DiscordConnector.d.ts:113
Send an OP 4 VOICE_STATE_UPDATE to the gateway.

Parameters
- data: <internal>.VoiceStateUpdatePayload & { self_deaf?: boolean; self_mute?: boolean }
  
  Voice state update data to send.
Returns Promise<void>

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

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

id: number

client: <internal>.Client

Returns DiscordConnector

Properties

Private _checkPresenceData

Private _checkRequestGuildMembersData

Private _checkVoiceStateUpdateData

Private _closing

Private _reconnect

_trace

betterWs

Private clearHeartBeat

client

Private handleDispatch

Private handleWsClose

Private heartbeat

heartbeatInterval

heartbeatTimeout

id

lastACKAt

lastHeartbeatSend

latency

Private messageAction

options

reconnect

Private reset

Private resume

seq

sessionId

status

Static Readonly default

Static defaultMaxListeners

Methods

addListener

Type Parameters

E extends keyof ConnectorEvents

Parameters

event: E

listener: ((...args: ConnectorEvents[E]) => any)

Parameters

Rest ...args: ConnectorEvents[E]

Returns any

Returns DiscordConnector

connect

Returns Promise<void>

disconnect

Returns Promise<void>

emit

Type Parameters

E extends keyof ConnectorEvents

Parameters

event: E

Rest ...args: ConnectorEvents[E]

Returns boolean

eventNames

Returns (keyof ConnectorEvents)[]

getMaxListeners

Returns number

identify

Parameters

Optional force: boolean

Returns Promise<void>

listenerCount

Parameters

event: keyof ConnectorEvents

Returns number

listeners

Parameters

event: keyof ConnectorEvents

Returns ((...args: any[]) => any)[]

off

Type Parameters