Aller au contenu
English

serveTaskQueue

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

Sert une TaskQueue appartenant à l’appelant via HTTP sur POST /queue, authentifiée par jetons bearer. Écoute par défaut sur 127.0.0.1 et un port choisi par le système, sans TLS. Refuse un jeton fixe qui ne compte pas 32 à 512 caractères sans espace.

Exemple complet et règles détaillées.

  • optionsRequis
    QueueServerOptions
    File à servir, jetons bearer acceptés, ainsi qu’hôte et port d’écoute.
  • options.queueRequis
    TaskQueue
    File servie via HTTP ; fermer le serveur la laisse ouverte.
  • options.tokenRequis
    string | (() => readonly string[] | Promise<readonly string[]>)
    Jeton bearer accepté de 32 à 512 caractères sans espace, ou fonction renvoyant les jetons acceptés, appelée à chaque requête. Renvoyez ancien et nouveau jetons ensemble pendant une rotation ; une liste vide ou une erreur levée refuse toutes les requêtes.
  • options.hostOptionnel
    string | undefined
    Adresse d’écoute, 127.0.0.1 par défaut.
  • options.portOptionnel
    number | undefined
    Port TCP, 0 par défaut : le système choisit un port libre, visible dans url.

Promise<QueueServer>

export declare function serveTaskQueue(
  options: QueueServerOptions,
): Promise<QueueServer>;