Class NoOpRateLimiterAdapter

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

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

Implements

IRateLimiterAdapter

Index

Constructors

Methods

getState reset updateState

Constructors

constructor

new NoOpRateLimiterAdapter(): NoOpRateLimiterAdapter
Returns NoOpRateLimiterAdapter

Methods

getState

getState(_key: string): Promise<IRateLimiterAdapterState>
The getState method returns the state of the rate limiter.
Parameters
- _key: string
Returns Promise<IRateLimiterAdapterState>
Implementation of IRateLimiterAdapter.getState
- Defined in src/rate-limiter/implementations/adapters/no-op-rate-limiter-adapter/no-op-rate-limiter-adapter.ts:20

reset

reset(_key: string): Promise<void>
The reset method resets rate limiter to its initial state regardless of the current state.
Parameters
- _key: string
Returns Promise<void>
Implementation of IRateLimiterAdapter.reset
- Defined in src/rate-limiter/implementations/adapters/no-op-rate-limiter-adapter/no-op-rate-limiter-adapter.ts:40

updateState

updateState(_key: string, limit: number): Promise<IRateLimiterAdapterState>
The updateState method updates the state of the rate limiter and returns the new state.
Parameters
- _key: string
- limit: number
Returns Promise<IRateLimiterAdapterState>
Implementation of IRateLimiterAdapter.updateState
- Defined in src/rate-limiter/implementations/adapters/no-op-rate-limiter-adapter/no-op-rate-limiter-adapter.ts:28