Class Shard

Hierarchy

EventEmitter
- Shard

Implements

SimpleJSON

Index

Constructors

constructor

Properties

Constructors

constructor

new Shard(id: number, client: Client): Shard

- Defined in node_modules/eris/index.d.ts:2297
Parameters
- id: number
- client: Client
Returns Shard

Properties

client

client: Client

connecting

connecting: boolean

Optional discordServerTrace

discordServerTrace: undefined | string[]

id

id: number

lastHeartbeatReceived

lastHeartbeatReceived: number

lastHeartbeatSent

lastHeartbeatSent: number

latency

latency: number

on

on: ShardEvents<Shard>

presence

presence: Presence

ready

ready: boolean

status

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

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

addListener(event: string | symbol, listener: (...args: any[]) => void): Shard

- Defined in node_modules/@types/node/globals.d.ts:547
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Shard

checkReady

checkReady(): void

- Defined in node_modules/eris/index.d.ts:2299
Returns void

connect

connect(): void

- Defined in node_modules/eris/index.d.ts:2300
Returns void

createGuild

createGuild(_guild: Guild): Guild

- Defined in node_modules/eris/index.d.ts:2301
Parameters
- _guild: Guild
Returns Guild

disconnect

disconnect(options?: { reconnect?: undefined | boolean | "auto" }, error?: Error): void

- Defined in node_modules/eris/index.d.ts:2302
Parameters
- Optional options: { reconnect?: undefined | boolean | "auto" }
  - Optional reconnect?: undefined | boolean | "auto"
- Optional error: Error
Returns void

editAFK

editAFK(afk: boolean): void

- Defined in node_modules/eris/index.d.ts:2303
Parameters
- afk: boolean
Returns void

editStatus

editStatus(status?: "online" | "idle" | "dnd" | "offline", game?: ActivityPartial<BotActivityType>): void
editStatus(game?: ActivityPartial<BotActivityType>): void

- Defined in node_modules/eris/index.d.ts:2304
Parameters
- Optional status: "online" | "idle" | "dnd" | "offline"
- Optional game: ActivityPartial<BotActivityType>
Returns void
- Defined in node_modules/eris/index.d.ts:2305
Parameters
- Optional game: ActivityPartial<BotActivityType>
Returns void

emit

emit(event: string, ...args: any[]): void

- Defined in node_modules/eris/index.d.ts:2307
Parameters
- event: string
- Rest ...args: any[]
Returns void

eventNames

eventNames(): (string | symbol)[]

- Defined in node_modules/@types/node/globals.d.ts:562
Returns (string | symbol)[]

getGuildMembers

getGuildMembers(guildID: string, timeout: number): void

- Defined in node_modules/eris/index.d.ts:2308
Parameters
- guildID: string
- timeout: number
Returns void

getMaxListeners

getMaxListeners(): number

- Defined in node_modules/@types/node/globals.d.ts:554
Returns number

hardReset

hardReset(): void

- Defined in node_modules/eris/index.d.ts:2309
Returns void

heartbeat

heartbeat(normal?: boolean): void

- Defined in node_modules/eris/index.d.ts:2310
Parameters
- Optional normal: boolean
Returns void

identify

identify(): void

- Defined in node_modules/eris/index.d.ts:2311
Returns void

initializeWS

initializeWS(): void

- Defined in node_modules/eris/index.d.ts:2312
Returns void

listenerCount

listenerCount(type: string | symbol): number

- Defined in node_modules/@types/node/globals.d.ts:558
Parameters
- type: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

- Defined in node_modules/@types/node/globals.d.ts:555
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: (...args: any[]) => void): Shard

- Defined in node_modules/@types/node/globals.d.ts:551
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Shard

onPacket

onPacket(packet: RawPacket): void

- Defined in node_modules/eris/index.d.ts:2313
Parameters
- packet: RawPacket
Returns void

once

once(event: string | symbol, listener: (...args: any[]) => void): Shard

- Defined in node_modules/@types/node/globals.d.ts:549
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Shard

prependListener

prependListener(event: string | symbol, listener: (...args: any[]) => void): Shard

- Defined in node_modules/@types/node/globals.d.ts:560
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Shard

prependOnceListener

prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): Shard

- Defined in node_modules/@types/node/globals.d.ts:561
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Shard

rawListeners

rawListeners(event: string | symbol): Function[]

- Defined in node_modules/@types/node/globals.d.ts:556
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): Shard

- Defined in node_modules/@types/node/globals.d.ts:552
Parameters
- Optional event: string | symbol
Returns Shard

removeListener

removeListener(event: string | symbol, listener: (...args: any[]) => void): Shard

- Defined in node_modules/@types/node/globals.d.ts:550
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Shard

requestGuildMembers

requestGuildMembers(guildID: string, options?: RequestGuildMembersOptions): Promise<RequestGuildMembersReturn>

- Defined in node_modules/eris/index.d.ts:2314
Parameters
- guildID: string
- Optional options: RequestGuildMembersOptions
Returns Promise<RequestGuildMembersReturn>

requestGuildSync

requestGuildSync(guildID: string): void

- Defined in node_modules/eris/index.d.ts:2315
Parameters
- guildID: string
Returns void

reset

reset(): void

- Defined in node_modules/eris/index.d.ts:2316
Returns void

restartGuildCreateTimeout

restartGuildCreateTimeout(): void

- Defined in node_modules/eris/index.d.ts:2317
Returns void

resume

resume(): void

- Defined in node_modules/eris/index.d.ts:2318
Returns void

sendStatusUpdate

sendStatusUpdate(): void

- Defined in node_modules/eris/index.d.ts:2319
Returns void

sendWS

sendWS(op: number, _data: Record<string, unknown>, priority?: boolean): void

- Defined in node_modules/eris/index.d.ts:2320
Parameters
- op: number
- _data: Record<string, unknown>
- Optional priority: boolean
Returns void

setMaxListeners

setMaxListeners(n: number): Shard

- Defined in node_modules/@types/node/globals.d.ts:553
Parameters
- n: number
Returns Shard

syncGuild

syncGuild(guildID: string): void

- Defined in node_modules/eris/index.d.ts:2321
Parameters
- guildID: string
Returns void

toJSON

toJSON(props?: string[]): JSONCache

Implementation of SimpleJSON.toJSON
- Defined in node_modules/eris/index.d.ts:2324
Parameters
- Optional props: string[]
Returns JSONCache

wsEvent

wsEvent(packet: Required<RawPacket>): void

- Defined in node_modules/eris/index.d.ts:2322
Parameters
- packet: Required<RawPacket>
Returns void

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

- Defined in node_modules/@types/node/events.d.ts:44
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Generated using TypeDoc