ShardHeart

@discordeno/gateway

---

Documentation / @discordeno/gateway / ShardHeart

Interface: ShardHeart

Defined in: gateway/src/types.ts:104

Properties

acknowledged

acknowledged: boolean

Defined in: gateway/src/types.ts:106

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

---

interval

interval: number

Defined in: gateway/src/types.ts:108

Interval between heartbeats requested by Discord.

---

intervalId?

optional intervalId: Timeout

Defined in: gateway/src/types.ts:110

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

---

lastAck?

optional lastAck: number

Defined in: gateway/src/types.ts:112

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

---

lastBeat?

optional lastBeat: number

Defined in: gateway/src/types.ts:114

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

---

rtt?

optional rtt: number

Defined in: gateway/src/types.ts:119

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: gateway/src/types.ts:121

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