ConcurrencyLimiterOptions
Defined in: src/rate-limiter.ts:23
Extends
Section titled “Extends”RejectionOptions
Properties
Section titled “Properties”
optionalname?:string
Defined in: src/window-rate-limiter.ts:306
Inherited from
Section titled “Inherited from”RejectionOptions.name
onRejected?
Section titled “onRejected?”
optionalonRejected?: (args) =>MaybePromise<void>
Defined in: src/window-rate-limiter.ts:307
Parameters
Section titled “Parameters”Returns
Section titled “Returns”MaybePromise<void>
Inherited from
Section titled “Inherited from”RejectionOptions.onRejected
overflow?
Section titled “overflow?”
optionaloverflow?:"reject-new"|"drop-oldest"|"drop-lowest-priority"
Defined in: src/rate-limiter.ts:37
When the queue is full: 'reject-new' (default) rejects the newcomer; 'drop-oldest' rejects the longest-waiting
execution instead; 'drop-lowest-priority' rejects the newest of the lowest priority, if the newcomer outranks it.
Dropped executions reject with BulkheadRejectedError reason 'dropped'.
permitLimit
Section titled “permitLimit”permitLimit:
number
Defined in: src/rate-limiter.ts:25
Max executions running at once.
priority?
Section titled “priority?”
optionalpriority?: (context) =>number
Defined in: src/rate-limiter.ts:31
Queue order: lower runs sooner (like a Unix nice value); FIFO within a priority. Default 0 for everyone.
Parameters
Section titled “Parameters”context
Section titled “context”Returns
Section titled “Returns”number
queueLimit?
Section titled “queueLimit?”
optionalqueueLimit?:number
Defined in: src/rate-limiter.ts:27
Max executions waiting (FIFO) for a permit. Default 0.
queueTimeout?
Section titled “queueTimeout?”
optionalqueueTimeout?:Duration
Defined in: src/rate-limiter.ts:29
Longest a queued execution waits for a permit before it is rejected. Default: no limit.