Class Shard

Shard class, which provides a wrapper around the DiscordConnector with metadata like the id of the shard.

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

Hierarchy

<internal>.EventEmitter
- Shard

Constructors

constructor

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

Inherited from EventEmitter.constructor
- Defined in node_modules/cloudstorm/dist/Shard.d.ts:40
Create a new Shard.

Parameters
- id: number
  
  id of the shard.
- client: <internal>.Client
  
  Main class used for forwarding events.
Returns Shard

Properties

client

client: <internal>.Client

connector

connector: DiscordConnector

id

id: number

ready

ready: boolean

Static Readonly default

default: typeof Shard

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

latency

get latency(): number

- Defined in node_modules/cloudstorm/dist/Shard.d.ts:44
Time in ms it took for Discord to ackknowledge an OP 1 HEARTBEAT.

Returns number

Methods

addListener

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

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

connect

connect(): void

- Defined in node_modules/cloudstorm/dist/Shard.d.ts:48
Create a new connection to Discord.

Returns void

disconnect

disconnect(): Promise<void>

- Defined in node_modules/cloudstorm/dist/Shard.d.ts:52
Close the current connection to Discord.

Returns Promise<void>

emit

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

Inherited from EventEmitter.emit
- Defined in node_modules/cloudstorm/dist/Shard.d.ts:11
Type Parameters
- E extends keyof ShardEvents
Parameters
- event: E
- Rest ...args: ShardEvents[E]
Returns boolean

eventNames

eventNames(): (keyof ShardEvents)[]

Inherited from EventEmitter.eventNames
- Defined in node_modules/cloudstorm/dist/Shard.d.ts:12
Returns (keyof ShardEvents)[]

getMaxListeners

getMaxListeners(): number

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

listenerCount

listenerCount(event: keyof ShardEvents): number

Inherited from EventEmitter.listenerCount
- Defined in node_modules/cloudstorm/dist/Shard.d.ts:13
Parameters
- event: keyof ShardEvents
Returns number

listeners

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

Inherited from EventEmitter.listeners
- Defined in node_modules/cloudstorm/dist/Shard.d.ts:14
Parameters
- event: keyof ShardEvents
Returns ((...args: any[]) => any)[]

off

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

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

on

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

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

once

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

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

prependListener

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

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

prependOnceListener

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

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

presenceUpdate

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

- Defined in node_modules/cloudstorm/dist/Shard.d.ts:57
Send an OP 3 PRESENCE_UPDATE to Discord.

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

rawListeners

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

Inherited from EventEmitter.rawListeners
- Defined in node_modules/cloudstorm/dist/Shard.d.ts:20
Parameters
- event: keyof ShardEvents
Returns ((...args: any[]) => any)[]

removeAllListeners

removeAllListeners(event?: keyof ShardEvents): Shard

Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/cloudstorm/dist/Shard.d.ts:21
Parameters
- Optional event: keyof ShardEvents
Returns Shard

removeListener

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

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

requestGuildMembers

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

- Defined in node_modules/cloudstorm/dist/Shard.d.ts:70
Send an OP 8 REQUEST_GUILD_MEMBERS to Discord.

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

setMaxListeners

setMaxListeners(n: number): Shard

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

voiceStateUpdate

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

- Defined in node_modules/cloudstorm/dist/Shard.d.ts:62
Send an OP 4 VOICE_STATE_UPDATE to Discord.

Parameters
- data: <internal>.VoiceStateUpdatePayload & { self_deaf?: boolean; self_mute?: boolean }
  
  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

Generated using TypeDoc