Type Alias IRateLimiter

IRateLimiter: IRateLimiterStateMethods & {
reset(): Promise<void>;
runOrFail<TValue = void>(asyncFn: AsyncLazy<TValue>): Promise<TValue>;
}

Rate limiting operations for controlling request throughput. Provides methods to execute async functions within rate limit constraints.

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

Type declaration

reset:function
- reset(): Promise<void>
- Resets the rate limiter to its initial state. Clears the request count and allows a fresh quota of requests.
  
  Returns Promise<void>
  - Defined in src/rate-limiter/contracts/rate-limiter.contract.ts:61
runOrFail:function
- runOrFail<TValue = void>(asyncFn: AsyncLazy<TValue>): Promise<TValue>
- Executes an async function if the rate limit quota is available. The request is blocked if the limit has been reached, throwing an error.
  Type Parameters
  - TValue = void
    The return type of the async function
  Parameters
  - asyncFn: AsyncLazy<TValue>
    The function to execute if rate limit allows
  Returns Promise<TValue>
  The return value of the function
  
  Throws
  If the rate limiter has reached its limit
  - Defined in src/rate-limiter/contracts/rate-limiter.contract.ts:55