Interface RateLimitOptions

interface RateLimitOptions {
    interval?: number;
    limit?: number;
    perHour?: number;
    perMinute?: number;
    perSecond?: number;
    signal?: AbortSignal;
}

Properties

interval? limit? perHour? perMinute? perSecond? signal?

Properties

Optionalinterval

interval?: number

interval in milliseconds

Optionallimit

limit?: number

how many to allow in parallel in any given interval

Default

1

OptionalperHour

perHour?: number

set limit to X per hour

OptionalperMinute

perMinute?: number

set limit to X per minute (can be fraction, i.e. 0.5 for 1 every 2 minutes)

OptionalperSecond

perSecond?: number

set limit to X per second

Optionalsignal

signal?: AbortSignal

cancel with AbortController

Settings

Member Visibility

On This Page

Properties