PURISTA

Appearance

PURISTA API

PURISTA API / @purista/core / DefaultQueueBridge

Class: DefaultQueueBridge ​

Defined in: DefaultQueueBridge/DefaultQueueBridge.impl.ts:25

Implements ​

Constructors ​

Constructor ​

new DefaultQueueBridge(options?): DefaultQueueBridge

Defined in: DefaultQueueBridge/DefaultQueueBridge.impl.ts:49

Parameters ​

options? ​

DefaultQueueBridgeOptions

Returns ​

DefaultQueueBridge

Properties ​

capabilities ​

readonly capabilities: QueueBridgeCapabilities

Defined in: DefaultQueueBridge/DefaultQueueBridge.impl.ts:28

Implementation of ​

QueueBridge.capabilities

instanceId ​

readonly instanceId: string

Defined in: DefaultQueueBridge/DefaultQueueBridge.impl.ts:41

Implementation of ​

QueueBridge.instanceId

name ​

readonly name: "DefaultQueueBridge" = 'DefaultQueueBridge'

Defined in: DefaultQueueBridge/DefaultQueueBridge.impl.ts:26

Implementation of ​

QueueBridge.name

Methods ​

ack() ​

ack(queueName, leaseId): Promise<void>

Defined in: DefaultQueueBridge/DefaultQueueBridge.impl.ts:148

Parameters ​

queueName ​

string

leaseId ​

string

Returns ​

Promise<void>

Implementation of ​

QueueBridge.ack

destroy() ​

destroy(): Promise<void>

Defined in: DefaultQueueBridge/DefaultQueueBridge.impl.ts:65

Returns ​

Promise<void>

Implementation of ​

QueueBridge.destroy

enqueue() ​

enqueue(options): Promise<QueueEnqueueResult>

Defined in: DefaultQueueBridge/DefaultQueueBridge.impl.ts:71

Parameters ​

options ​

QueueEnqueueOptions<unknown, unknown>

Returns ​

Promise<QueueEnqueueResult>

Implementation of ​

QueueBridge.enqueue

extendLease() ​

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

Defined in: DefaultQueueBridge/DefaultQueueBridge.impl.ts:138

Parameters ​

queueName ​

string

leaseId ​

string

extensionMs ​

number

Returns ​

Promise<void>

Implementation of ​

QueueBridge.extendLease

isHealthy() ​

isHealthy(): Promise<boolean>

Defined in: DefaultQueueBridge/DefaultQueueBridge.impl.ts:61

Returns ​

Promise<boolean>

Implementation of ​

QueueBridge.isHealthy

isReady() ​

isReady(): Promise<boolean>

Defined in: DefaultQueueBridge/DefaultQueueBridge.impl.ts:57

Returns ​

Promise<boolean>

Implementation of ​

QueueBridge.isReady

leaseNext() ​

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

Defined in: DefaultQueueBridge/DefaultQueueBridge.impl.ts:100

Parameters ​

queueName ​

string

_opts? ​

QueueLeaseOptions

Returns ​

Promise<QueueLease | undefined>

Implementation of ​

QueueBridge.leaseNext

metrics() ​

metrics(queueName): Promise<QueueMetrics>

Defined in: DefaultQueueBridge/DefaultQueueBridge.impl.ts:193

Parameters ​

queueName ​

string

Returns ​

Promise<QueueMetrics>

Implementation of ​

QueueBridge.metrics

moveToDeadLetter() ​

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

Defined in: DefaultQueueBridge/DefaultQueueBridge.impl.ts:181

Parameters ​

queueName ​

string

message ​

QueueMessage

reason? ​

string

Returns ​

Promise<void>

Implementation of ​

QueueBridge.moveToDeadLetter

nack() ​

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

Defined in: DefaultQueueBridge/DefaultQueueBridge.impl.ts:153

Parameters ​

queueName ​

string

leaseId ​

string

request ​

QueueRetryRequest

Returns ​

Promise<void>

Implementation of ​

QueueBridge.nack

start() ​

start(): Promise<void>

Defined in: DefaultQueueBridge/DefaultQueueBridge.impl.ts:55

Returns ​

Promise<void>

Implementation of ​

QueueBridge.start