basalt / queue-sqs/src / SqsQueuePluginOptions
Interface: SqsQueuePluginOptions
Defined in: queue-sqs/src/index.ts:353
Everything queuePlugin accepts, minus driver (this plugin IS the driver choice), plus every SQS driver option.
Extends
Omit<QueuePluginOptions,"driver">.SqsDriverOptions
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.
Inherited from
deadSuffix?
> optional deadSuffix?: string
Defined in: queue-sqs/src/index.ts:74
Suffix used to resolve the dead-letter queue's name. Default '-dead'.
Inherited from
errorPauseMs?
> optional errorPauseMs?: number
Defined in: queue-sqs/src/index.ts:88
Pause between consecutive failed receives, ms. Default 1000.
Inherited from
jobs?
> optional jobs?: JobDefinition<unknown>[]
Defined in: queue/src/index.ts:61
Jobs known to this process (producer and/or worker).
Inherited from
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?
Returns
void
Inherited from
onUnsupported?
> optional onUnsupported?: UnsupportedPolicy
Defined in: queue/src/index.ts:86
What to do when a job uses an option the driver can't honor (e.g. a delayed job on a driver without delayed delivery). Default 'warn' — set 'throw' in production for a hard guarantee, 'ignore' for the old behavior.
Inherited from
QueuePluginOptions.onUnsupported
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
Inherited from
region?
> optional region?: string
Defined in: queue-sqs/src/index.ts:72
Inherited from
removeOnComplete?
> optional removeOnComplete?: JobRetention
Defined in: queue/src/index.ts:93
Default retention for completed jobs, for drivers whose backend keeps them (BullMQ/Redis today). true removes on finish, a number keeps that many, { age: '7d', count: 500 } caps both. Default: keep the last 1000. A job can override via defineJob.
Inherited from
QueuePluginOptions.removeOnComplete
removeOnFail?
> optional removeOnFail?: JobRetention
Defined in: queue/src/index.ts:98
Default retention for failed jobs. Default false (keep all, for inspection and retries) — set e.g. { age: '14d' } so failures don't grow unbounded.
Inherited from
QueuePluginOptions.removeOnFail
signingKey?
> optional signingKey?: QueueSigningKey | readonly QueueSigningKey[]
Defined in: queue/src/index.ts:104
HMAC key(s) that sign every job envelope; the worker rejects unsigned or tampered jobs. Without it, anyone who can write to the broker can enqueue jobs and choose their tenant/user. See QueueManagerOptions.signingKey.
Inherited from
validateTenantId?
> optional validateTenantId?: (id) => boolean
Defined in: queue/src/index.ts:109
Tenant-id grammar accepted from a job's context. Default: tenancy's default grammar. Pass the same function you gave tenancyPlugin.
Parameters
id
string
Returns
boolean
Inherited from
QueuePluginOptions.validateTenantId
visibilityTimeout?
> optional visibilityTimeout?: number
Defined in: queue-sqs/src/index.ts:78
Visibility timeout while a message is being processed, seconds. Default 30.
Inherited from
SqsDriverOptions.visibilityTimeout
waitTimeSeconds?
> optional waitTimeSeconds?: number
Defined in: queue-sqs/src/index.ts:76
Long-poll wait, seconds. Default 20.
Inherited from
SqsDriverOptions.waitTimeSeconds
workers?
> optional workers?: object[]
Defined in: queue/src/index.ts:80
Queues to start workers for in this process at boot.
concurrency?
> optional concurrency?: number
queue
> queue: string