class SqsQueue
implements QueueAdapter
Since 0.1.0

SQS queue adapter.

Constructors

SqsQueue(
runtime: IRuntimeServices,
options: SqsQueueOptions,
logger?: { error: (msg: string) => void; }
)

Properties

Since 0.1.0
optional
isHealthy: () => Promise<boolean>

M70c: present only when the transport exposes isHealthy?() (the real adapter issues GetQueueAttributes); its absence is unknown reachability, not false.

Methods

Since 0.1.0
ack(
name: string,
id: string,
claimToken: string
): Promise<void>

Acknowledges a job as successfully processed.

Since 0.1.0
advanceRecurring(
id: string,
nextRunAtMs: number
): Promise<void>

Advances a recurring job's next run time.

Since 0.1.0
connect(): Promise<void>

Connects the adapter to its backend.

Since 0.1.0
deadLetter(
name: string,
id: string,
_nowMs: number,
claimToken: string
): Promise<void>

Moves a job to the dead letter queue.

Since 0.1.0
disconnect(): Promise<void>

Disconnects the adapter.

Since 0.1.0
enqueue<T>(job: StoredJob<T>): Promise<void>

Enqueues a job.

Since 0.1.0
fetchRecurringDue(nowMs: number): Promise<readonly StoredRecurring[]>

Fetches recurring jobs that are due.

Since 0.1.0
isReady(): boolean

Checks if the adapter is ready/connected.

Since 0.1.0
requeue(
name: string,
id: string,
availableAtMs: number,
_attempts: number,
claimToken: string
): Promise<void>

Requeues a job with a new available timestamp.

Since 0.1.0
reserve<T>(
name: string,
limit: number,
nowMs: number
): Promise<readonly StoredJob<T>[]>

Reserves up to limit jobs that are due (availableAtMs <= nowMs).

CLAIMS jobs: moves them from ready set to processing set. A reserved job is not returned by subsequent reserve calls.

Since 0.1.0
storeRecurring(rec: StoredRecurring): Promise<void>

Stores a recurring job.

Usage

import { SqsQueue } from "queue-plugin/src/index.ts";