Type Alias IRateLimiterStateMethods

IRateLimiterStateMethods: {
    key: IKey;
    limit: number;
    getState(): Promise<RateLimiterState>;
}

State and metadata methods for a rate limiter instance. Provides read-only access to rate limiter state and configuration properties.

IMPORT_PATH: "@daiso-tech/core/rate-limiter/contracts"

Type declaration

  • Readonlykey: IKey

    The unique identifier for this rate limiter instance. Multiple rate limiter instances with the same key share the same request quota.

  • Readonlylimit: number

    The maximum number of allowed requests within the rate limiting window.

  • getState:function