Skip to content

basalt / queue-sqs/src / SqsDriverOptions

Interface: SqsDriverOptions ​

Defined in: queue-sqs/src/index.ts:69

Extended by ​

Properties ​

api? ​

> optional api?: SqsApi

Defined in: queue-sqs/src/index.ts:90

Injectable SQS API — defaults to the AWS SDK. Tests pass a fake.


deadSuffix? ​

> optional deadSuffix?: string

Defined in: queue-sqs/src/index.ts:74

Suffix used to resolve the dead-letter queue's name. Default '-dead'.


errorPauseMs? ​

> optional errorPauseMs?: number

Defined in: queue-sqs/src/index.ts:88

Pause between consecutive failed receives, ms. Default 1000.


onError? ​

> optional onError?: (error, info) => void

Defined in: queue-sqs/src/index.ts:86

An SQS call failed: a receive (network/credentials/queue gone — without this the poller used to retry silently and immediately, a hot spin with zero log output), a delete after a job completed, or a retry/dead-letter re-send. stage says which. Never fatal: the poller keeps running. Default: console.error with context.

Parameters ​

error ​

unknown

info ​
queue ​

string

stage? ​

SqsErrorStage

Returns ​

void


queueUrl ​

> queueUrl: (queue) => string

Defined in: queue-sqs/src/index.ts:71

Resolves a queue name to its SQS queue URL.

Parameters ​

queue ​

string

Returns ​

string


region? ​

> optional region?: string

Defined in: queue-sqs/src/index.ts:72


visibilityTimeout? ​

> optional visibilityTimeout?: number

Defined in: queue-sqs/src/index.ts:78

Visibility timeout while a message is being processed, seconds. Default 30.


waitTimeSeconds? ​

> optional waitTimeSeconds?: number

Defined in: queue-sqs/src/index.ts:76

Long-poll wait, seconds. Default 20.

Released under the MIT License.