PURISTA API

---

PURISTA API / @purista/nats-queue-bridge / NatsQueueBridge

Class: NatsQueueBridge

Defined in: NatsQueueBridge.impl.ts:37

Implements

• QueueBridge

Constructors

Constructor

new NatsQueueBridge(options?): NatsQueueBridge

Defined in: NatsQueueBridge.impl.ts:78

Parameters

options?

NatsQueueBridgeOptions = {}

Returns

NatsQueueBridge

Properties

capabilities

readonly capabilities: QueueBridgeCapabilities

Defined in: NatsQueueBridge.impl.ts:40

Implementation of

QueueBridge.capabilities

---

instanceId

readonly instanceId: `${string}-${string}-${string}-${string}-${string}`

Defined in: NatsQueueBridge.impl.ts:61

Implementation of

QueueBridge.instanceId

---

name

readonly name: "NatsQueueBridge" = 'NatsQueueBridge'

Defined in: NatsQueueBridge.impl.ts:38

Implementation of

QueueBridge.name

Methods

ack()

ack(queueName, leaseId): Promise<void>

Defined in: NatsQueueBridge.impl.ts:192

Parameters

queueName

string

leaseId

string

Returns

Promise<void>

Implementation of

QueueBridge.ack

---

destroy()

destroy(): Promise<void>

Defined in: NatsQueueBridge.impl.ts:94

Returns

Promise<void>

Implementation of

QueueBridge.destroy

---

enqueue()

enqueue(options): Promise<QueueEnqueueResult>

Defined in: NatsQueueBridge.impl.ts:123

Parameters

options

QueueEnqueueOptions<unknown, unknown>

Returns

Promise<QueueEnqueueResult>

Implementation of

QueueBridge.enqueue

---

extendLease()

extendLease(queueName, leaseId, extensionMs): Promise<void>

Defined in: NatsQueueBridge.impl.ts:181

Parameters

queueName

string

leaseId

string

extensionMs

number

Returns

Promise<void>

Implementation of

QueueBridge.extendLease

---

inspectLeases()

inspectLeases(queueName, options?): Promise<QueueLeaseInspectionRecord[]>

Defined in: NatsQueueBridge.impl.ts:278

Parameters

queueName

string

options?

QueueDeadLetterListOptions

Returns

Promise<QueueLeaseInspectionRecord[]>

Implementation of

QueueBridge.inspectLeases

---

isHealthy()

isHealthy(): Promise<boolean>

Defined in: NatsQueueBridge.impl.ts:111

Returns

Promise<boolean>

Implementation of

QueueBridge.isHealthy

---

isReady()

isReady(): Promise<boolean>

Defined in: NatsQueueBridge.impl.ts:107

Returns

Promise<boolean>

Implementation of

QueueBridge.isReady

---

leaseNext()

leaseNext(queueName, options?): Promise<QueueLease | undefined>

Defined in: NatsQueueBridge.impl.ts:147

Parameters

queueName

string

options?

QueueLeaseOptions

Returns

Promise<QueueLease | undefined>

Implementation of

QueueBridge.leaseNext

---

metrics()

metrics(queueName): Promise<QueueMetrics>

Defined in: NatsQueueBridge.impl.ts:292

Parameters

queueName

string

Returns

Promise<QueueMetrics>

Implementation of

QueueBridge.metrics

---

moveToDeadLetter()

moveToDeadLetter(queueName, message, reason?): Promise<void>

Defined in: NatsQueueBridge.impl.ts:229

Parameters

queueName

string

message

QueueMessage

reason?

string

Returns

Promise<void>

Implementation of

QueueBridge.moveToDeadLetter

---

nack()

nack(queueName, leaseId, request): Promise<void>

Defined in: NatsQueueBridge.impl.ts:201

Parameters

queueName

string

leaseId

string

request

QueueRetryRequest

Returns

Promise<void>

Implementation of

QueueBridge.nack

---

peekDeadLetter()

peekDeadLetter(queueName, options?): Promise<QueueMessage[]>

Defined in: NatsQueueBridge.impl.ts:243

Parameters

queueName

string

options?

QueueDeadLetterListOptions

Returns

Promise<QueueMessage[]>

Implementation of

QueueBridge.peekDeadLetter

---

purgeDeadLetter()

purgeDeadLetter(queueName): Promise<number>

Defined in: NatsQueueBridge.impl.ts:269

Parameters

queueName

string

Returns

Promise<number>

Implementation of

QueueBridge.purgeDeadLetter

---

redriveDeadLetter()

redriveDeadLetter(queueName, options?): Promise<number>

Defined in: NatsQueueBridge.impl.ts:250

Parameters

queueName

string

options?

QueueDeadLetterRedriveOptions

Returns

Promise<number>

Implementation of

QueueBridge.redriveDeadLetter

---

start()

start(): Promise<void>

Defined in: NatsQueueBridge.impl.ts:86

Returns

Promise<void>

Implementation of

QueueBridge.start