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

EventEmitter
- Shard

Index

Methods

addListener

addListener<E>(event: E, listener: ((...args: ShardEvents[E]) => any)): Shard
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
- Defined in src/Shard.ts:14

connect

connect(): void
Create a new connection to Discord.

Returns void
- Defined in src/Shard.ts:87

disconnect

disconnect(): Promise<void>
Close the current connection to Discord.

Returns Promise<void>
- Defined in src/Shard.ts:94

emit

emit<E>(event: E, ...args: ShardEvents[E]): boolean
Type Parameters
- E extends keyof ShardEvents
Parameters
- event: E
- Rest ...args: ShardEvents[E]
Returns boolean
- Defined in src/Shard.ts:15

eventNames

eventNames(): (keyof ShardEvents)[]
Returns (keyof ShardEvents)[]
- Defined in src/Shard.ts:16

listenerCount

listenerCount(event: keyof ShardEvents): number
Parameters
- event: keyof ShardEvents
Returns number
- Defined in src/Shard.ts:17

listeners

listeners(event: keyof ShardEvents): ((...args: any[]) => any)[]
Parameters
- event: keyof ShardEvents
Returns ((...args: any[]) => any)[]
- Defined in src/Shard.ts:18

off

off<E>(event: E, listener: ((...args: ShardEvents[E]) => any)): Shard
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
- Defined in src/Shard.ts:19

on

on<E>(event: E, listener: ((...args: ShardEvents[E]) => any)): Shard
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
- Defined in src/Shard.ts:20

once

once<E>(event: E, listener: ((...args: ShardEvents[E]) => any)): Shard
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
- Defined in src/Shard.ts:21

prependListener

prependListener<E>(event: E, listener: ((...args: ShardEvents[E]) => any)): Shard
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
- Defined in src/Shard.ts:22

prependOnceListener

prependOnceListener<E>(event: E, listener: ((...args: ShardEvents[E]) => any)): Shard
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
- Defined in src/Shard.ts:23

presenceUpdate

presenceUpdate(data: GatewayPresenceUpdate): Promise<void>
Send an OP 3 PRESENCE_UPDATE to Discord.
Parameters
- data: GatewayPresenceUpdate
  
  Data to send.
Returns Promise<void>
- Defined in src/Shard.ts:102

rawListeners

rawListeners(event: keyof ShardEvents): ((...args: any[]) => any)[]
Parameters
- event: keyof ShardEvents
Returns ((...args: any[]) => any)[]
- Defined in src/Shard.ts:24

removeAllListeners

removeAllListeners(event?: keyof ShardEvents): Shard
Parameters
- Optional event: keyof ShardEvents
Returns Shard
- Defined in src/Shard.ts:25

removeListener

removeListener<E>(event: E, listener: ((...args: ShardEvents[E]) => any)): Shard
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
- Defined in src/Shard.ts:26

requestGuildMembers

requestGuildMembers(data: GuildRequestMembersPayload & {
limit?: number;
}): Promise<void>
Send an OP 8 REQUEST_GUILD_MEMBERS to Discord.
Parameters
- data: GuildRequestMembersPayload & {
  limit?: number;
  }
  
  Data to send.
Returns Promise<void>
- Defined in src/Shard.ts:118

voiceStateUpdate

voiceStateUpdate(data: VoiceStateUpdatePayload & {
self_deaf?: boolean;
self_mute?: boolean;
}): Promise<void>
Send an OP 4 VOICE_STATE_UPDATE to Discord.
Parameters
- data: VoiceStateUpdatePayload & {
  self_deaf?: boolean;
  self_mute?: boolean;
  }
  
  Data to send
Returns Promise<void>
- Defined in src/Shard.ts:110

Properties

client

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

connector

connector: DiscordConnector

id

id: number

ready

ready: boolean

Constructors

constructor

new Shard(id: number, client: EventEmitter & {
    options: Omit<IClientOptions, "snowtransferInstance"> & {
        endpoint?: string;
        token: string;
    };
}): Shard
Create a new Shard.
Parameters
- id: number
  
  id of the shard.
- client: EventEmitter & {
      options: Omit<IClientOptions, "snowtransferInstance"> & {
          endpoint?: string;
          token: string;
      };
  }
  
  Main class used for forwarding events.
Returns Shard
- Defined in src/Shard.ts:45

Accessors

latency

get latency(): number
Time in ms it took for Discord to ackknowledge an OP 1 HEARTBEAT.

Returns number
- Defined in src/Shard.ts:80

Class Shard

Hierarchy

Index

Methods

Properties

Constructors

Accessors

Methods

addListener

Type Parameters

E extends keyof ShardEvents

Parameters

event: E

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

Parameters

Rest ...args: ShardEvents[E]

Returns any

Returns Shard

connect

Returns void

disconnect

Returns Promise<void>

emit

Type Parameters

E extends keyof ShardEvents

Parameters

event: E

Rest ...args: ShardEvents[E]

Returns boolean

eventNames

Returns (keyof ShardEvents)[]

listenerCount

Parameters

event: keyof ShardEvents

Returns number

listeners

Parameters

event: keyof ShardEvents

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

off

Type Parameters

E extends keyof ShardEvents

Parameters

event: E

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

Parameters

Rest ...args: ShardEvents[E]

Returns any

Returns Shard

on

Type Parameters

E extends keyof ShardEvents

Parameters

event: E

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

Parameters

Rest ...args: ShardEvents[E]

Returns any

Returns Shard

once

Type Parameters

E extends keyof ShardEvents

Parameters

event: E

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

Parameters

Rest ...args: ShardEvents[E]

Returns any

Returns Shard

prependListener

Type Parameters

E extends keyof ShardEvents

Parameters

event: E

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

Parameters

Rest ...args: ShardEvents[E]

Returns any

Returns Shard

prependOnceListener

`Rest` ...args: ShardEvents[E]

`Rest` ...args: ShardEvents[E]

`Rest` ...args: ShardEvents[E]

`Rest` ...args: ShardEvents[E]

`Rest` ...args: ShardEvents[E]

`Rest` ...args: ShardEvents[E]

`Rest` ...args: ShardEvents[E]

`Optional` event: keyof ShardEvents

`Rest` ...args: ShardEvents[E]

data: GuildRequestMembersPayload & {
limit?: number;
}

data: VoiceStateUpdatePayload & {
self_deaf?: boolean;
self_mute?: boolean;
}

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