Skip to content

Graphorin API reference v0.1.0


Graphorin API reference / @graphorin/provider / / WithRateLimitOptions

Interface: WithRateLimitOptions

Defined in: packages/provider/src/middleware/with-rate-limit.ts:20

Options for withRateLimit.

Stable

Properties

PropertyModifierTypeDescriptionDefined in
burst?readonlynumberBurst size — defaults to requestsPerMinute / 4 (rounded up to >= 1).packages/provider/src/middleware/with-rate-limit.ts:24
mode?readonly"throw" | "queue"What to do on overflow. Default 'throw'.packages/provider/src/middleware/with-rate-limit.ts:26
nowImpl?readonly() => numberTest hook overriding Date.now.packages/provider/src/middleware/with-rate-limit.ts:28
requestsPerMinutereadonlynumberAllowed requests per minute.packages/provider/src/middleware/with-rate-limit.ts:22
sleepImpl?readonly(ms, signal?) => Promise<void>Test hook overriding setTimeout-based wait.packages/provider/src/middleware/with-rate-limit.ts:30