AdaptiveConcurrencyLimiterOptions

Defined in: src/adaptive-concurrency.ts:181

Extends

• RejectionOptions

Type Parameters

T

T = unknown

Properties

algorithm?

optional algorithm?: LimitAlgorithm | "vegas" | "gradient2" | "aimd"

Defined in: src/adaptive-concurrency.ts:183

Default ‘gradient2’. Pass an object for custom tuning (vegas({ alpha: 2 })) or your own algorithm.

---

initialLimit?

optional initialLimit?: number

Defined in: src/adaptive-concurrency.ts:185

Default 20.

---

limitProvider?

optional limitProvider?: AdaptiveLimitProvider

Defined in: src/adaptive-concurrency.ts:197

Read limit / inflight / queued from outside.

---

maxLimit?

optional maxLimit?: number

Defined in: src/adaptive-concurrency.ts:189

Default 1000.

---

minLimit?

optional minLimit?: number

Defined in: src/adaptive-concurrency.ts:187

Default 1.

---

name?

optional name?: string

Defined in: src/window-rate-limiter.ts:306

Inherited from

RejectionOptions.name

---

onLimitChanged?

optional onLimitChanged?: (args) => void

Defined in: src/adaptive-concurrency.ts:198

Parameters

args

OnLimitChangedArgs

Returns

void

---

onRejected?

optional onRejected?: (args) => MaybePromise<void>

Defined in: src/window-rate-limiter.ts:307

Parameters

args

OnRateLimiterRejectedArgs

Returns

MaybePromise<void>

Inherited from

RejectionOptions.onRejected

---

queueLimit?

optional queueLimit?: number

Defined in: src/adaptive-concurrency.ts:191

Max executions waiting (FIFO) for a permit. Default 0.

---

queueTimeout?

optional queueTimeout?: Duration

Defined in: src/adaptive-concurrency.ts:193

Longest a queued execution waits for a permit before it is rejected. Default: no limit.

---

shouldDrop?

optional shouldDrop?: (args) => boolean

Defined in: src/adaptive-concurrency.ts:195

Which outcomes signal overload. Default: timeouts, rejections and transient errors; not client errors (4xx) or aborts.

Parameters

args

OutcomeArgs<T>

Returns

boolean