QueueWorkerOptions

import type { QueueWorkerOptions } from "@elie-laloum/outpost";

Paramètres et propriétés

queueRequis
TaskQueue
File où le worker prend les jobs et enregistre leurs résultats.
workerRequis
string
Nom du worker enregistré sur chaque job pris en charge, de 1 à 512 caractères ; donnez-en un distinct à chaque processus.
handlersRequis
Readonly<Record<string, QueueHandler>>
Handlers par nom, de 1 à 100 ; le worker ne prend en charge que les jobs dont le handler figure ici.
signalRequis
AbortSignal
Arrête le worker : runQueueWorker() se résout et le signal du handler en cours s’interrompt. Ce job reste active jusqu’à l’expiration de son bail.
leaseMsOptionnel
number | undefined
Durée du bail en millisecondes, 30000 par défaut, de 30 à 300000 ; renouvelé à chaque tiers de cette durée.
pollMsOptionnel
number | undefined
Attente en millisecondes quand aucun job n’est éligible, 250 par défaut ; doit être positive.

Signature

export interface QueueWorkerOptions {
  readonly queue: TaskQueue;
  readonly worker: string;
  readonly handlers: Readonly<Record<string, QueueHandler>>;
  readonly signal: AbortSignal;
  readonly leaseMs?: number;
  readonly pollMs?: number;
}

Paramètres et propriétés

Signature

Contrats associés