Package: @hexos/runtime

Result of a rate limit check, indicating whether the request is allowed.

When allowed is false, retryAfterMs indicates how long the caller should wait before retrying. The remaining field shows how many requests are still available in the current window.

Related: SlidingWindowRateLimiter produces this result.

interface RateLimitResult {
    allowed: boolean;
    retryAfterMs: number;
    remaining: number;
    limit: number;
}

allowed

boolean

retryAfterMs

number

remaining

number

limit

number