Class Shard

Hierarchy

EventEmitter
- Shard

Index

Constructors

constructor

Properties

Constructors

constructor

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

- Defined in node_modules/eris/index.d.ts:1968
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

connect

connect(): void

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

disconnect

disconnect(options?: { reconnect: boolean }): void

- Defined in node_modules/eris/index.d.ts:1971
Parameters
- Optional options: { reconnect: boolean }
  - reconnect: boolean
Returns void

editAFK

editAFK(afk: boolean): void

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

editStatus

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

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

emit

emit(event: string | symbol, ...args: any[]): boolean

- Defined in node_modules/@types/node/globals.d.ts:557
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): (string | symbol)[]

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

getMaxListeners

getMaxListeners(): number

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

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

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

sendWS

sendWS(op: number, _data: object, priority: boolean): void

- Defined in node_modules/eris/index.d.ts:1977
Parameters
- op: number
- _data: object
- priority: boolean
Returns void

setMaxListeners

setMaxListeners(n: number): Shard

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

toJSON

toJSON(props?: string[]): JSONCache

- Defined in node_modules/eris/index.d.ts:1976
Parameters
- Optional props: string[]
Returns JSONCache

toString

toString(): string

- Defined in node_modules/eris/index.d.ts:1975
Returns string

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