Type Alias IRateLimiterStorageAdapter<TType>

Type declaration

• find:function

  • find(
        context: IReadableContext,
        key: string,
    ): Promise<null | IRateLimiterData<TType>>

  • Retrieves the stored rate limiter data without a transaction. Useful for read-only operations or standalone state checks. Returns null if the rate limiter hasn't been initialized.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      Unique identifier for the rate limiter

    Returns Promise<null | IRateLimiterData<TType>>

    The stored rate limiter data if found, otherwise null

• remove:function

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

  • Removes a rate limiter entry from the database. Called when explicitly resetting a rate limiter or cleaning up expired entries. Safe to call even if the rate limiter doesn't exist.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      Unique identifier for the rate limiter to remove

    Returns Promise<void>

• transaction:function

  • transaction<TValue>(
        context: IReadableContext,
        fn: InvokableFn<
            [transaction: IRateLimiterStorageAdapterTransaction<TType>],
            Promise<TValue>,
        >,
    ): Promise<TValue>

  • Executes rate limiter operations within a database transaction. Provides an IRateLimiterStorageAdapterTransaction object for atomic find/upsert operations.

    All database operations within the transaction function should succeed or fail atomically. If the transaction function throws, the transaction should be rolled back.

    Type Parameters

    • TValue

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • fn: InvokableFn<
          [transaction: IRateLimiterStorageAdapterTransaction<TType>],
          Promise<TValue>,
      >

      Callback function receiving transaction object, should return a Promise

    Returns Promise<TValue>

    The value returned by the fn callback