PURISTA

Appearance

PURISTA API

PURISTA API / @purista/redis-queue-bridge / RedisQueueBridge

Class: RedisQueueBridge<M, F, S, RESP, TYPE_MAPPING> ​

Defined in: RedisQueueBridge.impl.ts:36

Type Parameters ​

M ​

M extends RedisModules = RedisModules

F ​

F extends RedisFunctions = RedisFunctions

S ​

S extends RedisScripts = RedisScripts

RESP ​

RESP extends RespVersions = RespVersions

TYPE_MAPPING ​

TYPE_MAPPING extends TypeMapping = TypeMapping

Implements ​

Constructors ​

Constructor ​

new RedisQueueBridge<M, F, S, RESP, TYPE_MAPPING>(options?): RedisQueueBridge<M, F, S, RESP, TYPE_MAPPING>

Defined in: RedisQueueBridge.impl.ts:69

Parameters ​

options? ​

RedisQueueBridgeOptions<M, F, S, RESP, TYPE_MAPPING> = {}

Returns ​

RedisQueueBridge<M, F, S, RESP, TYPE_MAPPING>

Properties ​

capabilities ​

readonly capabilities: QueueBridgeCapabilities

Defined in: RedisQueueBridge.impl.ts:46

Implementation of ​

QueueBridge.capabilities

instanceId ​

readonly instanceId: string

Defined in: RedisQueueBridge.impl.ts:59

Implementation of ​

QueueBridge.instanceId

name ​

readonly name: "RedisQueueBridge" = 'RedisQueueBridge'

Defined in: RedisQueueBridge.impl.ts:44

Implementation of ​

QueueBridge.name

Methods ​

ack() ​

ack(queueName, leaseId): Promise<void>

Defined in: RedisQueueBridge.impl.ts:215

Parameters ​

queueName ​

string

leaseId ​

string

Returns ​

Promise<void>

Implementation of ​

QueueBridge.ack

destroy() ​

destroy(): Promise<void>

Defined in: RedisQueueBridge.impl.ts:87

Returns ​

Promise<void>

Implementation of ​

QueueBridge.destroy

enqueue() ​

enqueue(options): Promise<QueueEnqueueResult>

Defined in: RedisQueueBridge.impl.ts:106

Parameters ​

options ​

QueueEnqueueOptions<unknown, unknown>

Returns ​

Promise<QueueEnqueueResult>

Implementation of ​

QueueBridge.enqueue

extendLease() ​

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

Defined in: RedisQueueBridge.impl.ts:195

Parameters ​

queueName ​

string

leaseId ​

string

extensionMs ​

number

Returns ​

Promise<void>

Implementation of ​

QueueBridge.extendLease

isHealthy() ​

isHealthy(): Promise<boolean>

Defined in: RedisQueueBridge.impl.ts:97

Returns ​

Promise<boolean>

Implementation of ​

QueueBridge.isHealthy

isReady() ​

isReady(): Promise<boolean>

Defined in: RedisQueueBridge.impl.ts:93

Returns ​

Promise<boolean>

Implementation of ​

QueueBridge.isReady

leaseNext() ​

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

Defined in: RedisQueueBridge.impl.ts:147

Parameters ​

queueName ​

string

options? ​

QueueLeaseOptions

Returns ​

Promise<QueueLease | undefined>

Implementation of ​

QueueBridge.leaseNext

metrics() ​

metrics(queueName): Promise<{ deadLetter: number; inflight: number; oldestAgeMs: number | undefined; pending: number; retries: number; }>

Defined in: RedisQueueBridge.impl.ts:260

Parameters ​

queueName ​

string

Returns ​

Promise<{ deadLetter: number; inflight: number; oldestAgeMs: number | undefined; pending: number; retries: number; }>

Implementation of ​

QueueBridge.metrics

moveToDeadLetter() ​

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

Defined in: RedisQueueBridge.impl.ts:248

Parameters ​

queueName ​

string

message ​

QueueMessage

reason? ​

string

Returns ​

Promise<void>

Implementation of ​

QueueBridge.moveToDeadLetter

nack() ​

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

Defined in: RedisQueueBridge.impl.ts:231

Parameters ​

queueName ​

string

leaseId ​

string

request ​

QueueRetryRequest

Returns ​

Promise<void>

Implementation of ​

QueueBridge.nack

start() ​

start(): Promise<void>

Defined in: RedisQueueBridge.impl.ts:81

Returns ​

Promise<void>

Implementation of ​

QueueBridge.start