@agorio/sdkDocs


Class: TokenBucket

Constructors

new TokenBucket()

new TokenBucket(options): TokenBucket

Parameters

options: TokenBucketOptions

Returns

TokenBucket

Defined in

src/http/rate-limit.ts:36

Methods

available()

available(): number

Current token balance (after a refill tick). For introspection / tests.

Returns

number

Defined in

src/http/rate-limit.ts:67


take()

take(n): Promise<void>

Block until n tokens are available, then consume them. Tokens accrue at refillPerSec and cap at capacity.

Parameters

n: number = 1

Returns

Promise<void>

Defined in

src/http/rate-limit.ts:50