Class MemoryRateLimiterStorageAdapter<TType>

The MemoryRateLimiterStorageAdapter is used for easily facking IRateLimiterProvider for testing.

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

Type Parameters

TType

Implements

Index

Constructors

Methods

deInit find remove transaction

Constructors

constructor

new MemoryRateLimiterStorageAdapter<TType>(
map?: Map<string, MemoryRateLimiterData<TType>>,
): MemoryRateLimiterStorageAdapter<TType>
Type Parameters
- TType
Parameters
- map: Map<string, MemoryRateLimiterData<TType>> = ...
Returns MemoryRateLimiterStorageAdapter<TType>
Example
```
import { MemoryRateLimiterStorageAdapter } from "@daiso-tech/core/rate-limiter/memory-rate-limiter-storage-adapter";

const rateLimiterStorageAdapter = new MemoryRateLimiterStorageAdapter();
```
- Defined in src/rate-limiter/implementations/adapters/memory-rate-limiter-storage-adapter/memory-rate-limiter-storage-adapter.ts:41

Methods

deInit

deInit(): Promise<void>
Returns Promise<void>
Implementation of IDeinitizable.deInit
- Defined in src/rate-limiter/implementations/adapters/memory-rate-limiter-storage-adapter/memory-rate-limiter-storage-adapter.ts:45

find

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.
Implementation of IRateLimiterStorageAdapter.find
- Defined in src/rate-limiter/implementations/adapters/memory-rate-limiter-storage-adapter/memory-rate-limiter-storage-adapter.ts:83

remove

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>
Implementation of IRateLimiterStorageAdapter.remove
- Defined in src/rate-limiter/implementations/adapters/memory-rate-limiter-storage-adapter/memory-rate-limiter-storage-adapter.ts:94

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/memory-rate-limiter-storage-adapter/memory-rate-limiter-storage-adapter.ts:54