Class MemoryQueue

In-memory queue adapter implementation.

Provides a simple, synchronous-in-practice implementation using in-process data structures. All methods are wrapped in Promises to match the async adapter interface.

Since

0.1.0

Implements

QueueAdapter

Index

Constructors

constructor

Methods

ack advanceRecurring connect deadLetter depths disconnect enqueue fetchRecurringDue getDeadLetters isHealthy isReady requeue reserve storeRecurring

Constructors

constructor

new MemoryQueue(): MemoryQueue
Returns MemoryQueue
- Defined in packages/queue-plugin/src/adapters/memory-queue.ts:33

Methods

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)
- Optional_claimToken: string
Returns Promise<void>
Resolves when acknowledged

Throws
If the adapter is not connected

Since
0.1.0
Implementation of QueueAdapter.ack
- Defined in packages/queue-plugin/src/adapters/memory-queue.ts:133

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
Implementation of QueueAdapter.advanceRecurring
- Defined in packages/queue-plugin/src/adapters/memory-queue.ts:211

connect

connect(): Promise<void>
Connects the adapter to its backend.

Returns Promise<void>
Resolves when connected

Since
0.1.0
Implementation of QueueAdapter.connect
- Defined in packages/queue-plugin/src/adapters/memory-queue.ts:42

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
- Optional_claimToken: string
Returns Promise<void>
Resolves when dead-lettered

Throws
If the adapter is not connected

Since
0.1.0
Implementation of QueueAdapter.deadLetter
- Defined in packages/queue-plugin/src/adapters/memory-queue.ts:172

depths

depths(name: string): Promise<QueueDepths>
M70k (X8-4): counts this name's three states. Free for an in-process store, so there is no reason to omit it.
Parameters
- name: string
  Job name
Returns Promise<QueueDepths>
The depth of each state

Since
0.3.0
Implementation of QueueAdapter.depths
- Defined in packages/queue-plugin/src/adapters/memory-queue.ts:84

disconnect

disconnect(): Promise<void>
Disconnects the adapter.

Returns Promise<void>
Resolves when disconnected

Since
0.1.0
Implementation of QueueAdapter.disconnect
- Defined in packages/queue-plugin/src/adapters/memory-queue.ts:52

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
Implementation of QueueAdapter.enqueue
- Defined in packages/queue-plugin/src/adapters/memory-queue.ts:93

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
Implementation of QueueAdapter.fetchRecurringDue
- Defined in packages/queue-plugin/src/adapters/memory-queue.ts:202

getDeadLetters

getDeadLetters<T>(name: string): readonly StoredJob<T>[]
Returns the jobs dead-lettered under a queue name, in the order they were dead-lettered. A job lands here once it fails on its final attempt; the queue never delivers it again.

This is MemoryQueue-only observability: the Redis transport keeps its dead set in Redis, so inspect it there.
Type Parameters
- T
  The job payload type
Parameters
- name: string
  Job name
Returns readonly StoredJob<T>[]
The dead-lettered jobs for that name

Throws
If the adapter is not connected

Since
0.1.0
- Defined in packages/queue-plugin/src/adapters/memory-queue.ts:247

isHealthy

isHealthy(): Promise<boolean>
M70c: an in-memory queue has no backend to be unreachable, so it is always reachable (M47).

Returns Promise<boolean>
true

Since
0.1.0
Implementation of QueueAdapter.isHealthy
- Defined in packages/queue-plugin/src/adapters/memory-queue.ts:72

isReady

isReady(): boolean
Checks if the adapter is ready/connected.

Returns boolean
true if connected

Since
0.1.0
Implementation of QueueAdapter.isReady
- Defined in packages/queue-plugin/src/adapters/memory-queue.ts:61

requeue

requeue<T>(
    name: string,
    id: string,
    availableAtMs: number,
    attempts: number,
    _claimToken?: string,
): Promise<void>
Requeues a job with a new available timestamp.
Type Parameters
- T
Parameters
- name: string
  Job name
- id: string
  Job ID (stable public identity)
- availableAtMs: number
  When the job becomes available again
- attempts: number
  Updated attempt count
- Optional_claimToken: string
Returns Promise<void>
Resolves when requeued

Throws
If the adapter is not connected

Since
0.1.0
Implementation of QueueAdapter.requeue
- Defined in packages/queue-plugin/src/adapters/memory-queue.ts:143

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
Implementation of QueueAdapter.reserve
- Defined in packages/queue-plugin/src/adapters/memory-queue.ts:105

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
Implementation of QueueAdapter.storeRecurring
- Defined in packages/queue-plugin/src/adapters/memory-queue.ts:191

Class MemoryQueue

Since

Implements

Index

Constructors

Methods

Constructors

constructor

Returns MemoryQueue

Methods

ack

Parameters

Returns Promise<void>

Throws

Since

advanceRecurring

Parameters

Returns Promise<void>

Throws

Since

connect

Returns Promise<void>

Since

deadLetter

Parameters

Returns Promise<void>

Throws

Since

depths

Parameters

Returns Promise<QueueDepths>

Since

disconnect

Returns Promise<void>

Since

enqueue

Type Parameters

Parameters

Returns Promise<void>

Throws

Since

fetchRecurringDue

Parameters

Returns Promise<readonly StoredRecurring[]>

Throws

Since

getDeadLetters

Type Parameters

Parameters

Returns readonly StoredJob<T>[]

Throws

Since

isHealthy

Returns Promise<boolean>

Since

isReady

Returns boolean

Since

requeue

Type Parameters

Parameters

Returns Promise<void>

Throws

Since

reserve

Type Parameters

Parameters

Returns Promise<readonly StoredJob<T>[]>

Throws

Since

storeRecurring

Parameters

Returns Promise<void>

Throws

Since

Settings

On This Page