Type Alias IRateLimiterStorageAdapter<TType>

Type declaration

• find:function

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

  • Retrieves the current rate limiter state for a given key.

    Parameters

    • key: string

      The unique identifier for the rate limiter.

    Returns Promise<null | IRateLimiterData<TType>>

    Returns the rate limiter state if found, otherwise null.

• remove:function

  • remove(key: string): Promise<void>

  • Removes a rate limiter from the database.

    Parameters

    • key: string

      The unique identifier for the rate limiter to remove.

    Returns Promise<void>

• transaction:function

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

  • The transaction method runs the fn function inside a transaction. The fn function is given a IRateLimiterStorageAdapterTransaction object.

    Type Parameters

    • TValue

    Parameters

    • fn: InvokableFn<
          [transaction: IRateLimiterStorageAdapterTransaction<TType>],
          Promise<TValue>,
      >

    Returns Promise<TValue>