Shard | yuuko

Hierarchy

EventEmitter
- Shard

Implements

SimpleJSON

Index

Constructors

constructor

Constructors

constructor

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

Overrides EventEmitter.constructor
- Defined in node_modules/eris/index.d.ts:3371
Parameters
- id: number
- client: Client
Returns Shard

Properties

client

client: Client

connectAttempts

connectAttempts: number

connectTimeout

connectTimeout: null | Timeout

connecting

connecting: boolean

Optional discordServerTrace

discordServerTrace: string[]

getAllUsersCount

getAllUsersCount: {}

Type declaration

[guildID: string]: boolean

getAllUsersLength

getAllUsersLength: number

getAllUsersQueue

getAllUsersQueue: string

globalBucket

globalBucket: Bucket

guildCreateTimeout

guildCreateTimeout: null | Timeout

guildSyncQueue

guildSyncQueue: string[]

guildSyncQueueLength

guildSyncQueueLength: number

heartbeatInterval

heartbeatInterval: null | Timeout

id

id: number

lastHeartbeatAck

lastHeartbeatAck: boolean

lastHeartbeatReceived

lastHeartbeatReceived: null | number

lastHeartbeatSent

lastHeartbeatSent: null | number

latency

latency: number

preReady

preReady: boolean

presence

presence: ClientPresence

presenceUpdateBucket

presenceUpdateBucket: Bucket

ready

ready: boolean

reconnectInterval

reconnectInterval: number

requestMembersPromise

requestMembersPromise: {}

Type declaration

[s: string]: RequestMembersPromise

seq

seq: number

sessionID

sessionID: null | string

status

unsyncedGuilds

unsyncedGuilds: number

ws

ws: any

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Methods

addListener

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

Inherited from EventEmitter.addListener
- Defined in node_modules/@types/node/events.d.ts:57
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:3372
Returns void

connect

connect(): void

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

createGuild

createGuild(_guild: Guild): Guild

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

disconnect

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

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

editAFK

editAFK(afk: boolean): void

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

editStatus

editStatus(status: SelfStatus, activities?: ActivityPartial<BotActivityType> | ActivityPartial<BotActivityType>[]): void
editStatus(activities?: ActivityPartial<BotActivityType> | ActivityPartial<BotActivityType>[]): void

- Defined in node_modules/eris/index.d.ts:3377
Parameters
- status: SelfStatus
- Optional activities: ActivityPartial<BotActivityType> | ActivityPartial<BotActivityType>[]
Returns void
- Defined in node_modules/eris/index.d.ts:3378
Parameters
- Optional activities: ActivityPartial<BotActivityType> | ActivityPartial<BotActivityType>[]
Returns void

emit

emit(event: string, ...args: any[]): void
emit<K>(event: K, ...args: ShardEvents[K]): boolean
emit(event: string, ...args: any[]): boolean

Overrides EventEmitter.emit
- Defined in node_modules/eris/index.d.ts:3380
Parameters
- event: string
- Rest ...args: any[]
Returns void
Overrides EventEmitter.emit
- Defined in node_modules/eris/index.d.ts:3381
Type parameters
- K: keyof ShardEvents
Parameters
- event: K
- Rest ...args: ShardEvents[K]
Returns boolean
Overrides EventEmitter.emit
- Defined in node_modules/eris/index.d.ts:3382
Parameters
- event: string
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): (string | symbol)[]

Inherited from EventEmitter.eventNames
- Defined in node_modules/@types/node/events.d.ts:72
Returns (string | symbol)[]

getGuildMembers

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

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

getMaxListeners

getMaxListeners(): number

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

hardReset

hardReset(): void

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

heartbeat

heartbeat(normal?: boolean): void

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

identify

identify(): void

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

initializeWS

initializeWS(): void

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

listenerCount

listenerCount(event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- event: string | symbol
Returns number

listeners

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

Inherited from EventEmitter.listeners
- Defined in node_modules/@types/node/events.d.ts:65
Parameters
- event: string | symbol
Returns Function[]

off

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

Overrides EventEmitter.off
- Defined in node_modules/eris/index.d.ts:3388
Type parameters
- K: keyof ShardEvents
Parameters
- event: K
- listener: (...args: ShardEvents[K]) => void
  - - (...args: ShardEvents[K]): void
    - Parameters
      - Rest ...args: ShardEvents[K]
      Returns void
Returns Shard
Overrides EventEmitter.off
- Defined in node_modules/eris/index.d.ts:3389
Parameters
- event: string
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Shard

on

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

Overrides EventEmitter.on
- Defined in node_modules/eris/index.d.ts:3402
Type parameters
- K: keyof ShardEvents
Parameters
- event: K
- listener: (...args: ShardEvents[K]) => void
  - - (...args: ShardEvents[K]): void
    - Parameters
      - Rest ...args: ShardEvents[K]
      Returns void
Returns Shard
Overrides EventEmitter.on
- Defined in node_modules/eris/index.d.ts:3403
Parameters
- event: string
- 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:3392
Parameters
- packet: RawPacket
Returns void

once

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

Overrides EventEmitter.once
- Defined in node_modules/eris/index.d.ts:3390
Type parameters
- K: keyof ShardEvents
Parameters
- event: K
- listener: (...args: ShardEvents[K]) => void
  - - (...args: ShardEvents[K]): void
    - Parameters
      - Rest ...args: ShardEvents[K]
      Returns void
Returns Shard
Overrides EventEmitter.once
- Defined in node_modules/eris/index.d.ts:3391
Parameters
- event: string
- 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

Inherited from EventEmitter.prependListener
- Defined in node_modules/@types/node/events.d.ts:70
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

Inherited from EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/events.d.ts:71
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[]

Inherited from EventEmitter.rawListeners
- Defined in node_modules/@types/node/events.d.ts:66
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): Shard

Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:62
Parameters
- Optional event: string | symbol
Returns Shard

removeListener

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

Inherited from EventEmitter.removeListener
- Defined in node_modules/@types/node/events.d.ts:60
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:3393
Parameters
- guildID: string
- Optional options: RequestGuildMembersOptions
Returns Promise<RequestGuildMembersReturn>

requestGuildSync

requestGuildSync(guildID: string): void

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

reset

reset(): void

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

restartGuildCreateTimeout

restartGuildCreateTimeout(): void

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

resume

resume(): void

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

sendStatusUpdate

sendStatusUpdate(): void

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

sendWS

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

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

setMaxListeners

setMaxListeners(n: number): Shard

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

syncGuild

syncGuild(guildID: string): void

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

toJSON

toJSON(props?: string[]): JSONCache

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

wsEvent

wsEvent(packet: Required<RawPacket>): void

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

Static listenerCount

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

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:26
deprecated

since v4.0.0

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

Static on

on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>

Inherited from EventEmitter.on
- Defined in node_modules/@types/node/events.d.ts:23
Parameters
- emitter: EventEmitter
- event: string
Returns AsyncIterableIterator<any>

Static once

once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>
once(emitter: DOMEventTarget, event: string): Promise<any[]>

Inherited from EventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:21
Parameters
- emitter: NodeEventTarget
- event: string | symbol
Returns Promise<any[]>
Inherited from EventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:22
Parameters
- emitter: DOMEventTarget
- event: string
Returns Promise<any[]>

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

id: number

client: Client

Returns Shard

Properties

client

connectAttempts

connectTimeout

connecting

Optional discordServerTrace

getAllUsersCount

Type declaration

[guildID: string]: boolean

getAllUsersLength

getAllUsersQueue

globalBucket

guildCreateTimeout

guildSyncQueue

guildSyncQueueLength

heartbeatInterval

id

lastHeartbeatAck

lastHeartbeatReceived

lastHeartbeatSent

latency

preReady

presence

presenceUpdateBucket

ready

reconnectInterval

requestMembersPromise

Type declaration

[s: string]: RequestMembersPromise

seq

sessionID

status

unsyncedGuilds

ws

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static Readonly errorMonitor

Methods

addListener

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns Shard

checkReady

Returns void

connect

Returns void

createGuild

Parameters

_guild: Guild

Returns Guild

disconnect

Parameters

Optional options: { reconnect?: boolean | "auto" }

Optional reconnect?: boolean | "auto"

Optional error: Error

Returns void

editAFK

Parameters

afk: boolean

Returns void

editStatus

Parameters

status: SelfStatus