RateLimitStrategy
RateLimitStrategy =
object
Defined in: packages/core/src/rest/strategy.ts:36
Controls request throughput for a platform’s rate limiting scheme.
Precondition
Section titled “Precondition”One strategy instance per platform
Postcondition
Section titled “Postcondition”acquire() resolves when it’s safe to proceed with the request
Methods
Section titled “Methods”acquire()
Section titled “acquire()”acquire(
req):Promise<RateLimitHandle>
Defined in: packages/core/src/rest/strategy.ts:42
Called before each request. Consumes a token/quota unit and returns a handle. May block (await) if tokens are exhausted.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<RateLimitHandle>
getStatus()
Section titled “getStatus()”getStatus():
RateLimitStatus
Defined in: packages/core/src/rest/strategy.ts:44
Current rate limit status (for telemetry).