Skip to content

IdentifyCoordinatorOptions

Defined in: packages/sharding/src/identify.ts:15

Options for an IdentifyCoordinator.

optional budget?: IdentifyBudget

Defined in: packages/sharding/src/identify.ts:21

The session-start budget, when known. Without it the coordinator paces but never blocks.


optional cancel?: (handle) => void

Defined in: packages/sharding/src/identify.ts:28

unknown

void


optional holdTimeout?: number

Defined in: packages/sharding/src/identify.ts:23

A granted slot that is not released within this many ms is released for the holder. Default 60,000.


optional interval?: number

Defined in: packages/sharding/src/identify.ts:19

Milliseconds between two IDENTIFYs on one key. Default 5000.


optional maxConcurrency?: number

Defined in: packages/sharding/src/identify.ts:17

Discord’s max_concurrency: shards with the same id % maxConcurrency share a key. Default 1.


optional now?: () => number

Defined in: packages/sharding/src/identify.ts:25

Clock, injectable for tests.

number


optional onBudgetWait?: (info) => void

Defined in: packages/sharding/src/identify.ts:30

Called when a request has to wait for the budget to reset.

number

number

void


optional onEvent?: (event) => void

Defined in: packages/sharding/src/identify.ts:32

Called for every queue change, for logs and metrics.

IdentifyEvent

void


optional schedule?: (callback, ms) => unknown

Defined in: packages/sharding/src/identify.ts:27

Timer, injectable for tests. Must return a handle cancel understands.

() => void

number

unknown