Interface QueueOptions

Represents the queue options

interface QueueOptions {
    bucketSize?: number;
    highWater?: number;
    interval?: number;
    penalty?: number;
    strategy?: Strategy;
    tokensPerInterval?: number;
}

Hierarchy (View Summary)

Properties

bucketSize? highWater? interval? penalty? strategy? tokensPerInterval?

Properties

OptionalbucketSize

bucketSize?: number

Set the bucket size for the rate limiter

Default Value

0 If the bucket size is 0, only concurrency and delay will be used to limit the rate of the jobs. If the bucket size is greater than 0, the consumption of the tokens will be used to limit the rate of the jobs. The bucket size is the maximum number of tokens that can be consumed in the interval. The interval is defined by the tokensPerInterval and interval properties.

See

https://en.wikipedia.org/wiki/Token_bucket

OptionalhighWater

highWater?: number

The maximum number of jobs in the queue

Default Value

Infinity

Optionalinterval

interval?: number

Define the interval in milliseconds

Default Value

1000

Optionalpenalty

penalty?: number

The penalty for the BLOCK strategy in milliseconds

Default Value

0

Optionalstrategy

strategy?: Strategy

The strategy to use when the queue length reaches highWater

Default Value

'leak'

OptionaltokensPerInterval

tokensPerInterval?: number

Define the number of tokens that will be added to the bucket at the beginning of the interval

Default Value

1

Settings

Member Visibility

On This Page

Properties