Class SqsQueue

constructor

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

  Parameters

  • runtime: IRuntimeServices
  • options: SqsQueueOptions
  • Optionallogger: { error: (msg: string) => void }

  Returns SqsQueue

OptionalisHealthy

ack

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

  Acknowledges a job as successfully processed.

  Parameters

  • name: string

    Job name

  • id: string

    Job ID (stable public identity)

  • claimToken: string

    Opaque claim token returned from reserve (prevents stale settlement)

  Returns Promise<void>

  Resolves when acknowledged

  Throws

  If the adapter is not connected

  Since

  0.1.0

advanceRecurring

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

  Advances a recurring job's next run time.

  Parameters

  • id: string

    Recurring job ID

  • nextRunAtMs: number

    Next run timestamp

  Returns Promise<void>

  Resolves when advanced

  Throws

  If the adapter is not connected

  Since

  0.1.0

connect

• connect(): Promise<void>

  Connects the adapter to its backend.

  Returns Promise<void>

  Resolves when connected

  Since

  0.1.0

deadLetter

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

  Moves a job to the dead letter queue.

  Parameters

  • name: string

    Job name

  • id: string

    Job ID (stable public identity)

  • _nowMs: number
  • claimToken: string

    Opaque claim token returned from reserve (prevents stale settlement)

  Returns Promise<void>

  Resolves when dead-lettered

  Throws

  If the adapter is not connected

  Since

  0.1.0

disconnect

• disconnect(): Promise<void>

  Disconnects the adapter.

  Returns Promise<void>

  Resolves when disconnected

  Since

  0.1.0

enqueue

• enqueue<T>(job: StoredJob<T>): Promise<void>

  Enqueues a job.

  Type Parameters

  • T

  Parameters

  • job: StoredJob<T>

    The job to enqueue

  Returns Promise<void>

  Resolves when enqueued

  Throws

  If the adapter is not connected

  Since

  0.1.0

fetchRecurringDue

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

  Fetches recurring jobs that are due.

  Parameters

  • nowMs: number

    Current timestamp in ms

  Returns Promise<readonly StoredRecurring[]>

  The due recurring jobs

  Throws

  If the adapter is not connected

  Since

  0.1.0

isReady

• isReady(): boolean

  Checks if the adapter is ready/connected.

  Returns boolean

  true if connected

  Since

  0.1.0

requeue

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

  Requeues a job with a new available timestamp.

  Parameters

  • name: string

    Job name

  • id: string

    Job ID (stable public identity)

  • availableAtMs: number

    When the job becomes available again

  • _attempts: number
  • claimToken: string

    Opaque claim token returned from reserve (prevents stale settlement)

  Returns Promise<void>

  Resolves when requeued

  Throws

  If the adapter is not connected

  Since

  0.1.0

reserve

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

  Reserves up to limit due jobs. Redis scripts use server time; adapters without a server clock compare availableAtMs to nowMs.

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

  Type Parameters

  • T

  Parameters

  • name: string

    Job name

  • limit: number

    Maximum jobs to reserve

  • nowMs: number

    Caller timestamp in ms, used when there is no server clock

  Returns Promise<readonly StoredJob<T>[]>

  The reserved jobs

  Throws

  If the adapter is not connected

  Since

  0.1.0

storeRecurring

• storeRecurring(rec: StoredRecurring): Promise<void>

  Stores a recurring job.

  Parameters

  • rec: StoredRecurring

    The recurring job to store

  Returns Promise<void>

  Resolves when stored

  Throws

  If the adapter is not connected

  Since

  0.1.0