Interface IFunAsyncRateLimitOptions

Options for

See

funAsyncRateLimit

Hierarchy

  • IFunAsyncRateLimitOptions

Properties

autoStart?: boolean

Whether queue tasks within concurrency limit, are auto-executed as soon as they're added.

Default

true
carryoverConcurrencyCount?: boolean

Whether the task must finish in the given interval or will be carried over into the next interval count.

Default

false
concurrency?: number

Concurrency limit. Minimum: 1.

Default

Infinity
interval?: number

The length of time in milliseconds before the interval count resets. Must be finite. Minimum: 0.

Default

0
intervalCap?: number

The max number of runs in the given interval of time. Minimum: 1.

Default

Infinity
throwOnTimeout?: boolean

Whether or not a timeout is considered an exception.

Default

false
timeout?: number

Per-operation timeout in milliseconds. Operations fulfill once timeout elapses if they haven't already.

Generated using TypeDoc