Documentation / @super-line/plugin-queue / QueueHandle

Interface: QueueHandle<Q, N>

Defined in: packages/plugin-queue/src/index.ts:217

One queue's namespace: everything keyed by queue name, with the name already applied.

Type Parameters

Q

Q extends QueueDefinitions

N

N extends QueueName<Q>

Properties

hasWorker

readonly hasWorker: boolean

Defined in: packages/plugin-queue/src/index.ts:220

Whether a worker is bound for this queue on this node. Unbound queues are never claimed here.

---

name

readonly name: N

Defined in: packages/plugin-queue/src/index.ts:218

---

schedules

readonly schedules: object

Defined in: packages/plugin-queue/src/index.ts:226

create()

create(options): Promise<{ createdAt: number; cron: string; enabled: boolean; id: string; input: unknown; lastJobId?: string; lastScheduledAt?: number; maxCatchUp?: number; misfirePolicy: "skip" | "latest" | "all"; nextRunAt: number; overlapPolicy: "skip" | "allow"; queue: string; revision: number; timezone: string; updatedAt: number; }>

Parameters

options

HandleScheduleCreate<Q, N>

Returns

Promise<{ createdAt: number; cron: string; enabled: boolean; id: string; input: unknown; lastJobId?: string; lastScheduledAt?: number; maxCatchUp?: number; misfirePolicy: "skip" | "latest" | "all"; nextRunAt: number; overlapPolicy: "skip" | "allow"; queue: string; revision: number; timezone: string; updatedAt: number; }>

list()

list(query?): Promise<object[]>

Parameters

query?

CollectionQuery

Returns

Promise<object[]>

Methods

enqueue()

enqueue(input, options?): Promise<{ attempt: number; availableAt: number; backoff: { delayMs: number; jitter?: number; maxDelayMs?: number; type: "fixed" | "exponential"; }; cancelReason?: string; cancelRequestedAt?: number; createdAt: number; deleteAt?: number; finishedAt?: number; id: string; input: unknown; lastError?: { at: number; attempt: number; code?: string; message: string; name: string; }; leaseExpiresAt?: number; maxAttempts: number; nodeId?: string; nodeKey?: string; priority: number; queue: string; result?: unknown; retention: { cancelledMs: number | null; completedMs: number | null; failedMs: number | null; }; retryOf?: string; revision: number; rootJobId?: string; runId?: string; scheduledFor?: number; scheduleId?: string; slotId?: string; startedAt?: number; status: "queued" | "running" | "completed" | "failed" | "cancelled"; timeoutMs?: number; updatedAt: number; }>

Defined in: packages/plugin-queue/src/index.ts:223

Parameters

input

InputOf<Q, N>

options?

EnqueueOptions

Returns

Promise<{ attempt: number; availableAt: number; backoff: { delayMs: number; jitter?: number; maxDelayMs?: number; type: "fixed" | "exponential"; }; cancelReason?: string; cancelRequestedAt?: number; createdAt: number; deleteAt?: number; finishedAt?: number; id: string; input: unknown; lastError?: { at: number; attempt: number; code?: string; message: string; name: string; }; leaseExpiresAt?: number; maxAttempts: number; nodeId?: string; nodeKey?: string; priority: number; queue: string; result?: unknown; retention: { cancelledMs: number | null; completedMs: number | null; failedMs: number | null; }; retryOf?: string; revision: number; rootJobId?: string; runId?: string; scheduledFor?: number; scheduleId?: string; slotId?: string; startedAt?: number; status: "queued" | "running" | "completed" | "failed" | "cancelled"; timeoutMs?: number; updatedAt: number; }>

---

list()

list(query?): Promise<object[]>

Defined in: packages/plugin-queue/src/index.ts:225

Jobs of this queue only — a filter you pass is ANDed with that scope.

Parameters

query?

CollectionQuery

Returns

Promise<object[]>

---

setWorker()

setWorker(worker): void

Defined in: packages/plugin-queue/src/index.ts:222

Bind this queue's worker. The last call wins, including over one declared inline in queues.

Parameters

worker

WorkerOf<Q, N>

Returns

void