Interface RateLimitResult

Result of a rate limit check

interface RateLimitResult {
    allowed: boolean;
    remaining: number;
    limit: number;
    resetIn: number;
    resetAt: Date;
    retryAfter?: number;
}

Index

Properties

allowed remaining limit resetIn resetAt retryAfter?

Properties

`Readonly`allowed

allowed: boolean

Whether the request is allowed

`Readonly`remaining

remaining: number

Number of remaining requests in the current window

`Readonly`limit

limit: number

Maximum requests allowed per window

`Readonly`resetIn

resetIn: number

Time in milliseconds until the limit resets

`Readonly`resetAt

resetAt: Date

ISO timestamp when the limit resets

`Optional` `Readonly`retryAfter

retryAfter?: number

Time to wait before retrying (if not allowed), in milliseconds

Interface RateLimitResult

Index

Properties

Properties

`Readonly`allowed

`Readonly`remaining

`Readonly`limit

`Readonly`resetIn

`Readonly`resetAt

`Optional` `Readonly`retryAfter

Settings

On This Page

Interface RateLimitResult

Index

Properties

Properties

Readonlyallowed

Readonlyremaining

Readonlylimit

ReadonlyresetIn

ReadonlyresetAt

Optional ReadonlyretryAfter

Settings

On This Page

`Readonly`allowed

`Readonly`remaining

`Readonly`limit

`Readonly`resetIn

`Readonly`resetAt

`Optional` `Readonly`retryAfter