Class RateLimiter

A rate limiter that provides an "isAvailable" method which ensures that no more than the provided maximum can be used.

Index

Methods

isAvailable perDay perHour perMinute perSecond

Methods

isAvailable

isAvailable(count: number): boolean
Checks whether or not the provided count of the limited resource is currently available or if it has been used up.
Parameters
- count: number
  The amount of the limited resource to request.
Returns boolean
True when the provided count is available, false otherwise.
- Defined in src/rate-limiting/rate-limiter.model.ts:72

`Static`perDay

perDay(max: number): RateLimiter
Creates a rate limiter with the provided maximum available per day.
Parameters
- max: number
  The maximum available per day.
Returns RateLimiter
The RateLimiter.
- Defined in src/rate-limiting/rate-limiter.model.ts:24

`Static`perHour

perHour(max: number): RateLimiter
Creates a rate limiter with the provided maximum available per hour.
Parameters
- max: number
  The maximum available per hour.
Returns RateLimiter
The RateLimiter.
- Defined in src/rate-limiting/rate-limiter.model.ts:33

`Static`perMinute

perMinute(max: number): RateLimiter
Creates a rate limiter with the provided maximum available per minute.
Parameters
- max: number
  The maximum available per minute.
Returns RateLimiter
The RateLimiter.
- Defined in src/rate-limiting/rate-limiter.model.ts:42

`Static`perSecond

perSecond(max: number): RateLimiter
Creates a rate limiter with the provided maximum available per second.
Parameters
- max: number
  The maximum available per seconds.
Returns RateLimiter
The RateLimiter.
- Defined in src/rate-limiting/rate-limiter.model.ts:51