Skip to main content

ShardHeart

@discordeno/bot

Documentation / @discordeno/bot / ShardHeart

Interface: ShardHeart

Defined in: packages/gateway/dist/types/types.d.ts:100

Properties​

acknowledged​

acknowledged: boolean

Defined in: packages/gateway/dist/types/types.d.ts:102

Whether or not the heartbeat was acknowledged by Discord in time.

interval​

interval: number

Defined in: packages/gateway/dist/types/types.d.ts:104

Interval between heartbeats requested by Discord.

intervalId?​

optional intervalId: Timeout

Defined in: packages/gateway/dist/types/types.d.ts:106

Id of the interval, which is used for sending the heartbeats.

lastAck?​

optional lastAck: number

Defined in: packages/gateway/dist/types/types.d.ts:108

Unix (in milliseconds) timestamp when the last heartbeat ACK was received from Discord.

lastBeat?​

optional lastBeat: number

Defined in: packages/gateway/dist/types/types.d.ts:110

Unix timestamp (in milliseconds) when the last heartbeat was sent.

rtt?​

optional rtt: number

Defined in: packages/gateway/dist/types/types.d.ts:115

Round trip time (in milliseconds) from Shard to Discord and back. Calculated using the heartbeat system. Note: this value is undefined until the first heartbeat to Discord has happened.

timeoutId?​

optional timeoutId: Timeout

Defined in: packages/gateway/dist/types/types.d.ts:117

Id of the timeout which is used for sending the first heartbeat to Discord since it's "special".