Skip to main content

Interface: RateLimitResult

Defined in: rateLimit.ts:4

What one RateLimiter.consume call answers.

Properties​

allowed​

allowed: boolean

Defined in: rateLimit.ts:6

Whether this request is inside the limit. It was counted only if so.

remaining​

remaining: number

Defined in: rateLimit.ts:8

Requests left in the current window after this one.

resetAt​

resetAt: number

Defined in: rateLimit.ts:10

When the current window ends, in epoch milliseconds.