Class NoOpRateLimiterStorageAdapter<TType>

The NoOpRateLimiterStorageAdapterTransaction will do nothing and is used for easily mocking IRateLimiterProvider for testing.

IMPORT_PATH: "@daiso-tech/core/rate-limiter/no-op-rate-limiter-storage-adapter"

Type Parameters

TType

Implements

IRateLimiterStorageAdapter<TType>

Index

Constructors

Methods

find remove transaction

Constructors

constructor

new NoOpRateLimiterStorageAdapter<TType>(): NoOpRateLimiterStorageAdapter<TType>
Type Parameters
- TType
Returns NoOpRateLimiterStorageAdapter<TType>

Methods

find

find(_key: string): Promise<null | IRateLimiterData<TType>>
Retrieves the current rate limiter state for a given key.
Parameters
- _key: string
Returns Promise<null | IRateLimiterData<TType>>
Returns the rate limiter state if found, otherwise null.
Implementation of IRateLimiterStorageAdapter.find
- Defined in src/rate-limiter/implementations/adapters/no-op-rate-limiter-storage-adapter/no-op-rate-limiter-storage-adapter.ts:50

remove

remove(_key: string): Promise<void>
Removes a rate limiter from the database.
Parameters
- _key: string
Returns Promise<void>
Implementation of IRateLimiterStorageAdapter.remove
- Defined in src/rate-limiter/implementations/adapters/no-op-rate-limiter-storage-adapter/no-op-rate-limiter-storage-adapter.ts:54

transaction

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>
Implementation of IRateLimiterStorageAdapter.transaction
- Defined in src/rate-limiter/implementations/adapters/no-op-rate-limiter-storage-adapter/no-op-rate-limiter-storage-adapter.ts:39