Type Alias IRateLimiterAdapter

Type declaration

• getState:function

  • getState(
        context: IReadableContext,
        key: string,
    ): Promise<null | IRateLimiterAdapterState>

  • Retrieves the current rate limiter state without modifying it. Returns the tracking metrics if the rate limiter exists, otherwise null.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      Unique identifier for the rate limiter

    Returns Promise<null | IRateLimiterAdapterState>

    Current adapter state if found, or null if not yet initialized

• reset:function

  • reset(context: IReadableContext, key: string): Promise<void>

  • Resets the rate limiter to its initial state. Clears all attempt tracking and lifts any blocking status. Can be called even if the rate limiter has expired or was never initialized.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      Unique identifier for the rate limiter to reset

    Returns Promise<void>

• updateState:function

  • updateState(
        context: IReadableContext,
        key: string,
        limit: number,
    ): Promise<IRateLimiterAdapterState>

  • Updates the rate limiter state and checks against the configured limit. Increments attempt counter and determines if the request should be allowed or blocked. The decision logic is handled by the policy interface configured for this adapter.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      Unique identifier for the rate limiter
    • limit: number

      Maximum allowed attempts in the current window

    Returns Promise<IRateLimiterAdapterState>

    Updated state with incremented attempt and success flag