Classes · @purista/nats-queue-bridge

NatsQueueBridge

Strict QueueBridge implementation backed by NATS JetStream streams and KV.

@purista/nats-queue-bridge Source

Signature

NatsQueueBridge.ts typescript 
class NatsQueueBridge

Examples

example-1.ts typescript 
import { NatsQueueBridge } from '@purista/nats-queue-bridge'

const queueBridge = new NatsQueueBridge({
  connectionOptions: { servers: 'nats://localhost:4222' },
  defaultMaxAttempts: 5,
})

await queueBridge.start()
example-2.ts typescript 
const first = await queueBridge.enqueue({
  queueName: 'billing.invoice-email',
  payload: { invoiceId: 'inv_123' },
  idempotencyKey: 'invoice-email:inv_123',
})

const duplicate = await queueBridge.enqueue({
  queueName: 'billing.invoice-email',
  payload: { invoiceId: 'inv_123' },
  idempotencyKey: 'invoice-email:inv_123',
})

first.jobId === duplicate.jobId

Constructors

1 entry

constructor

Constructor

Source
constructor.ts typescript 
new constructor(options: NatsQueueBridgeOptions)

Creates a NATS JetStream queue bridge with the provided options.

Properties

3 entries

capabilities

Property

Source
capabilities.ts typescript 
capabilities: QueueBridgeCapabilities

Queue capabilities supported by this JetStream bridge.

instanceId

Property

Source
instanceId.ts typescript 
instanceId: `template`

Unique bridge instance identifier for diagnostics and lease ownership.

name

Property

Source
name.ts typescript 
name: "NatsQueueBridge"

Stable bridge name reported to PURISTA runtime diagnostics.

Methods

15 entries

ack

Method

Source
ack.ts typescript 
ack(queueName: string, leaseId: string): Promise<void>

Acknowledges successful processing and removes the local lease tracking.

destroy

Method

Source
destroy.ts typescript 
destroy(): Promise<void>

Drains and closes the NATS connection and clears local lease/consumer caches.

enqueue

Method

Source
enqueue.ts typescript 
enqueue(options: QueueEnqueueOptions<unknown, unknown>): Promise<QueueEnqueueResult>

Enqueues a job, optionally scheduled for later delivery.

extendLease

Method

Source
extendLease.ts typescript 
extendLease(queueName: string, leaseId: string, extensionMs: number): Promise<void>

Extends a currently tracked lease.

inspectLeases

Method

Source
inspectLeases.ts typescript 
inspectLeases(queueName: string, options?: QueueDeadLetterListOptions): Promise<QueueLeaseInspectionRecord[]>

Returns leases currently tracked by this bridge instance.

isHealthy

Method

Source
isHealthy.ts typescript 
isHealthy(): Promise<boolean>

Performs a lightweight connection flush to verify broker health.

isReady

Method

Source
isReady.ts typescript 
isReady(): Promise<boolean>

Indicates whether the bridge has an open NATS connection.

leaseNext

Method

Source
leaseNext.ts typescript 
leaseNext(queueName: string, options?: QueueLeaseOptions): Promise<QueueLease | undefined>

Leases the next available job from a queue.

metrics

Method

Source
metrics.ts typescript 
metrics(queueName: string): Promise<QueueMetrics>

Returns broker-derived queue metrics for pending, in-flight, and dead-lettered jobs.

moveToDeadLetter

Method

Source
moveToDeadLetter.ts typescript 
moveToDeadLetter(queueName: string, message: QueueMessage, reason?: string): Promise<void>

Moves a message directly to the queue dead-letter stream.

nack

Method

Source
nack.ts typescript 
nack(queueName: string, leaseId: string, request: QueueRetryRequest): Promise<void>

Retries or dead-letters a leased job.

peekDeadLetter

Method

Source
peekDeadLetter.ts typescript 
peekDeadLetter(queueName: string, options?: QueueDeadLetterListOptions): Promise<QueueMessage[]>

Reads dead-lettered jobs without redriving or deleting them.

purgeDeadLetter

Method

Source
purgeDeadLetter.ts typescript 
purgeDeadLetter(queueName: string): Promise<number>

Deletes all jobs in the queue dead-letter stream and returns the deleted count.

redriveDeadLetter

Method

Source
redriveDeadLetter.ts typescript 
redriveDeadLetter(queueName: string, options?: QueueDeadLetterRedriveOptions): Promise<number>

Redrives dead-lettered jobs back to the pending queue and removes them from the dead-letter stream.

start

Method

Source
start.ts typescript 
start(): Promise<void>

Connects to NATS and initializes JetStream clients.