GatewaySendLimiter
Defined in: packages/ws/src/send-budget.ts:10
Sliding-window budget for outgoing Gateway payloads. Heartbeats, IDENTIFY and RESUME are privileged: they always go out (and are still counted), so application traffic can never starve them.
Discord allows 120 sends per 60 seconds. Application traffic is capped at 115 so the remaining headroom is reserved for privileged sends (heartbeats), which are still recorded so the true total stays under Discord’s limit.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new GatewaySendLimiter(
limit?,windowMs?):GatewaySendLimiter
Defined in: packages/ws/src/send-budget.ts:15
Parameters
Section titled “Parameters”limit?
Section titled “limit?”number = 115
windowMs?
Section titled “windowMs?”number = 60_000
Returns
Section titled “Returns”GatewaySendLimiter
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get used():
number
Defined in: packages/ws/src/send-budget.ts:21
Sends recorded within the current window.
Returns
Section titled “Returns”number
Methods
Section titled “Methods”allows()
Section titled “allows()”allows(
privileged,now?):boolean
Defined in: packages/ws/src/send-budget.ts:26
Whether a send may go out now. Privileged sends always may.
Parameters
Section titled “Parameters”privileged
Section titled “privileged”boolean
number = ...
Returns
Section titled “Returns”boolean
record()
Section titled “record()”record(
now?):void
Defined in: packages/ws/src/send-budget.ts:36
Records a send that went out.
Parameters
Section titled “Parameters”number = ...
Returns
Section titled “Returns”void