PURISTA

Appearance

PURISTA API

PURISTA API / @purista/core / QueueBridge

Interface: QueueBridge ​

Defined in: core/QueueBridge/types/QueueBridge.ts:10

Properties ​

capabilities ​

readonly capabilities: QueueBridgeCapabilities

Defined in: core/QueueBridge/types/QueueBridge.ts:13

instanceId ​

readonly instanceId: string

Defined in: core/QueueBridge/types/QueueBridge.ts:12

name ​

readonly name: string

Defined in: core/QueueBridge/types/QueueBridge.ts:11

Methods ​

ack() ​

ack(queueName, leaseId): Promise<void>

Defined in: core/QueueBridge/types/QueueBridge.ts:23

Parameters ​

queueName ​

string

leaseId ​

string

Returns ​

Promise<void>

destroy() ​

destroy(): Promise<void>

Defined in: core/QueueBridge/types/QueueBridge.ts:18

Returns ​

Promise<void>

enqueue() ​

enqueue(options): Promise<QueueEnqueueResult>

Defined in: core/QueueBridge/types/QueueBridge.ts:20

Parameters ​

options ​

QueueEnqueueOptions<unknown, unknown>

Returns ​

Promise<QueueEnqueueResult>

extendLease() ​

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

Defined in: core/QueueBridge/types/QueueBridge.ts:22

Parameters ​

queueName ​

string

leaseId ​

string

extensionMs ​

number

Returns ​

Promise<void>

isHealthy() ​

isHealthy(): Promise<boolean>

Defined in: core/QueueBridge/types/QueueBridge.ts:17

Returns ​

Promise<boolean>

isReady() ​

isReady(): Promise<boolean>

Defined in: core/QueueBridge/types/QueueBridge.ts:16

Returns ​

Promise<boolean>

leaseNext() ​

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

Defined in: core/QueueBridge/types/QueueBridge.ts:21

Parameters ​

queueName ​

string

options? ​

QueueLeaseOptions

Returns ​

Promise<QueueLease | undefined>

metrics() ​

metrics(queueName): Promise<QueueMetrics>

Defined in: core/QueueBridge/types/QueueBridge.ts:26

Parameters ​

queueName ​

string

Returns ​

Promise<QueueMetrics>

moveToDeadLetter() ​

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

Defined in: core/QueueBridge/types/QueueBridge.ts:25

Parameters ​

queueName ​

string

message ​

QueueMessage

reason? ​

string

Returns ​

Promise<void>

nack() ​

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

Defined in: core/QueueBridge/types/QueueBridge.ts:24

Parameters ​

queueName ​

string

leaseId ​

string

request ​

QueueRetryRequest

Returns ​

Promise<void>

start() ​

start(): Promise<void>

Defined in: core/QueueBridge/types/QueueBridge.ts:15

Returns ​

Promise<void>