Class RateLimiter

A Lock that issues permits at a fixed rate.

Implements

Lock

Index

Constructors

Properties

interval resetTimer semaphore

Methods

acquire release resetLimit triggerPermitReset tryAcquire

Constructors

constructor

new RateLimiter(permits?, period?, buffer?): RateLimiter
Parameters
- permits: number = 1
  Total number of permits issued over given period.
- period: number = 1000
  The time period in milliseconds.
- Optional buffer: Int32Array
  Shared array buffer for permit synchronization.
Returns RateLimiter
- Defined in packages/commons/src/async/ratelimiter.ts:11

Properties

`Private` `Readonly` interval

interval: number

`Private` resetTimer

resetTimer: number = 0

`Readonly` semaphore

semaphore: SharedCountingSemaphore

Methods

acquire

acquire(options?): Promise<void>
Waits for a lock to be acquired.
Parameters
- Optional options: AbortOptions
Returns Promise<void>
Implementation of Lock.acquire
- Defined in packages/commons/src/async/ratelimiter.ts:23

release

release(): void
Releases a lock.

Returns void
Implementation of Lock.release
- Defined in packages/commons/src/async/ratelimiter.ts:36

`Private` resetLimit

resetLimit(): void
Returns void
- Defined in packages/commons/src/async/ratelimiter.ts:44

`Private` triggerPermitReset

triggerPermitReset(): void
Returns void
- Defined in packages/commons/src/async/ratelimiter.ts:40

tryAcquire

tryAcquire(): boolean
Tried to acquire a lock. Returns true if success, false otherwise.

Returns boolean
Implementation of Lock.tryAcquire
- Defined in packages/commons/src/async/ratelimiter.ts:28

Generated using TypeDoc