Shard | discord-rose

Utility manager for a shard

Hierarchy

EventEmitter<DiscordDefaultEventMap & { CLOSED: [code: number, reason: string] }>
- Shard

Index

Constructors

constructor

Properties

Accessors

ready
state

Methods

Constructors

constructor

new Shard(id: number, worker: Worker): Shard

Overrides EventEmitter<DiscordDefaultEventMap & { CLOSED: [code: number, reason: string] }>.constructor
- Defined in src/socket/Shard.ts:21
Parameters
- id: number
- worker: Worker
Returns Shard

Properties

id

id: number

ping

ping: number = 0

Ping in ms

worker

worker: Worker

Accessors

ready

get ready(): boolean

- Defined in src/socket/Shard.ts:92
Whether or not the shard is READY

Returns boolean

state

get state(): State

- Defined in src/socket/Shard.ts:82
Current shard state

Returns State

Methods

getGuildMembers

getGuildMembers(opts: GatewayRequestGuildMembersData): Promise<Collection<string, APIGuildMember>>

- Defined in src/socket/Shard.ts:131
Parameters
- opts: GatewayRequestGuildMembersData
Returns Promise<Collection<string, APIGuildMember>>

register

register(): Promise<{}>

- Defined in src/socket/Shard.ts:110
Returns Promise<{}>

restart

restart(kill: boolean, code?: number, reason?: string): void

- Defined in src/socket/Shard.ts:115
Parameters
- kill: boolean
- code: number = 1012
- reason: string = 'Manually Stopped'
Returns void

setPresence

setPresence(presence: GatewayPresenceUpdateData): void

- Defined in src/socket/Shard.ts:124
Parameters
- presence: GatewayPresenceUpdateData
Returns void

start

start(): void

- Defined in src/socket/Shard.ts:96
Returns void

Generated using TypeDoc