Interfaces · @purista/core

QueueBridge

Queue transport adapter contract used by PURISTA services and queue workers.

Signature

QueueBridge.ts typescript
interface QueueBridge

Properties

3 entries

capabilities

Property

Source
capabilities.ts typescript
capabilities: QueueBridgeCapabilities

Runtime capability matrix used for strict queue validation.

instanceId

Property

Source
instanceId.ts typescript
instanceId: string

Stable runtime instance id used to distinguish bridge processes.

name

Property

Source
name.ts typescript
name: string

Human-readable adapter name used in diagnostics, logs, and metrics.

Methods

15 entries

ack

Method

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

Acknowledge successful processing and remove the leased message.

destroy

Method

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

Release provider resources and stop background bridge activity.

enqueue

Method

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

Enqueue a queue message and return provider-visible job metadata.

extendLease

Method

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

Extend an active lease so long-running work can continue safely.

inspectLeases

Method

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

Inspect active leases when the adapter supports lease diagnostics.

isHealthy

Method

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

Returns whether the bridge can currently make progress.

isReady

Method

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

Returns whether the bridge has completed startup and can accept calls.

leaseNext

Method

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

Lease the next available message for a worker, if one is ready.

metrics

Method

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

Return queue-level operational metrics for health and dashboards.

moveToDeadLetter

Method

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

Move a message to the dead-letter store with an optional safe reason.

nack

Method

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

Return a leased message to the queue or move it toward dead-letter policy.

peekDeadLetter

Method

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

Inspect dead-letter messages without redriving or deleting them.

purgeDeadLetter

Method

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

Delete all dead-letter messages for the queue.

redriveDeadLetter

Method

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

Move dead-letter messages back to the live queue.

start

Method

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

Start the bridge and establish any provider connection needed for work.