Skip to main content

Interface: WorkerOptions

Defined in: libs/sdk/src/worker.ts:36

Properties​

batchHandler()?​

optional batchHandler: (messages) => Promise<undefined | void | WorkerMessage[]>

Defined in: libs/sdk/src/worker.ts:45

Process a batch. Return acknowledged messages, or undefined to skip all.

Parameters​

messages​

WorkerMessage[]

Returns​

Promise<undefined | void | WorkerMessage[]>

batchSize?​

optional batchSize: number

Defined in: libs/sdk/src/worker.ts:47

Max messages per poll (1-10, default 1 for handler, 10 for batchHandler).

handleMessageTimeout?​

optional handleMessageTimeout: number

Defined in: libs/sdk/src/worker.ts:57

Milliseconds to wait for handler before timing out (default: none).

handler()?​

optional handler: (message) => Promise<undefined | void | WorkerMessage>

Defined in: libs/sdk/src/worker.ts:38

Process a single message. Return the message to acknowledge, or undefined to skip.

Parameters​

message​

WorkerMessage

Returns​

Promise<undefined | void | WorkerMessage>

heartbeatInterval?​

optional heartbeatInterval: number

Defined in: libs/sdk/src/worker.ts:55

Seconds between heartbeat calls to extend visibility (default: auto from visibilityTimeout).

pollingWaitTimeMs?​

optional pollingWaitTimeMs: number

Defined in: libs/sdk/src/worker.ts:53

Milliseconds to wait between polls when queue is empty (default 0).

shouldDeleteMessages?​

optional shouldDeleteMessages: boolean

Defined in: libs/sdk/src/worker.ts:59

Whether to auto-delete messages after successful processing (default true).

shutdownWaitMs?​

optional shutdownWaitMs: number

Defined in: libs/sdk/src/worker.ts:43

How long stop() waits for in-flight handlers before giving up, in milliseconds. Defaults to 5000.

visibilityTimeout?​

optional visibilityTimeout: number

Defined in: libs/sdk/src/worker.ts:49

Seconds before unprocessed message becomes visible again (default 30).

waitTimeSeconds?​

optional waitTimeSeconds: number

Defined in: libs/sdk/src/worker.ts:51

Long-poll wait time in seconds (default 20, max 20).