Type Alias IRateLimiterAdapter

IRateLimiterAdapter: {
    getState(key: string): Promise<null | IRateLimiterAdapterState>;
    reset(key: string): Promise<void>;
    updateState(key: string, limit: number): Promise<IRateLimiterAdapterState>;
}

The IRateLimiterAdapter contract defines a way for managing rate limiters independent of the underlying technology and algorithm. This contract is not meant to be used directly, instead you should use IRateLimiterProvider contract.

IMPORT_PATH: "@daiso-tech/core/rate-limiter/contracts"

Type declaration

getState:function
- getState(key: string): Promise<null | IRateLimiterAdapterState>
- The getState method returns the state of the rate limiter.
  Parameters
  - key: string
  Returns Promise<null | IRateLimiterAdapterState>
  - Defined in src/rate-limiter/contracts/rate-limiter-adapter.contract.ts:32
reset:function
- 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>
  - Defined in src/rate-limiter/contracts/rate-limiter-adapter.contract.ts:42
updateState:function
- 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>
  - Defined in src/rate-limiter/contracts/rate-limiter-adapter.contract.ts:37

Type Alias IRateLimiterAdapter

Type declaration

getState:function

Parameters

Returns Promise<null | IRateLimiterAdapterState>

reset:function

Parameters

Returns Promise<void>

updateState:function

Parameters

Returns Promise<IRateLimiterAdapterState>

Settings