Skip to main content

ShardHeart

@discordeno/bot • Docs

Documentation / @discordeno/bot / ShardHeart

Interface: ShardHeart

Properties​

acknowledged​

acknowledged: boolean

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

Defined in​

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

interval​

interval: number

Interval between heartbeats requested by Discord.

Defined in​

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

intervalId?​

optional intervalId: Timeout

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

Defined in​

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

lastAck?​

optional lastAck: number

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

Defined in​

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

lastBeat?​

optional lastBeat: number

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

Defined in​

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

rtt?​

optional rtt: number

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.

Defined in​

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

timeoutId?​

optional timeoutId: Timeout

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

Defined in​

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