serveTriggers

Rôle et comportement

Démarre un serveur HTTP qui vérifie chaque POST avec la source de sa route et publie le job choisi par on() sous trigger:<path>:<delivery> ; les relivraisons ne publient rien de nouveau. Il répond 202, 204, 400, 401, 404, 405, 413, 500 ou 503, une source peut remplacer 202 et 204, et il se résout une fois à l’écoute ; des options invalides ou un port indisponible rejettent. L’appelant ferme le serveur, puis sa file.

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

Paramètres et propriétés

• optionsRequis
  TriggerServerOptions
  File, routes, adresse d’écoute, limite de corps et observateur d’échecs.
• options.queueRequis
  TaskQueue
  File qui reçoit les jobs ; une publication refusée répond 503.
• options.routesRequis
  readonly TriggerRoute[]
  Au moins une route avec un chemin unique.
• options.hostOptionnel
  string | undefined
  Adresse d’écoute ; 127.0.0.1 par défaut. Exposez le serveur derrière un proxy qui termine TLS.
• options.portOptionnel
  number | undefined
  Port d’écoute ; 0 ou l’absence choisit un port libre indiqué dans url.
• options.maxBytesOptionnel
  number | undefined
  Limite du corps de requête en octets ; 1 Mio par défaut, au plus 25 Mio. Les corps plus grands répondent 413.
• options.onErrorOptionnel
  ((error: unknown, failure: TriggerFailure) => void) | undefined
  Observe les échecs de vérification, de routage et de publication avec le chemin et, après vérification, la livraison ; ne reçoit jamais de secrets. Les erreurs levées par le rappel sont ignorées.

Retour

Promise<TriggerServer>

Signature

export declare function serveTriggers(
  options: TriggerServerOptions,
): Promise<TriggerServer>;

Contrats associés

• TriggerServer
• TriggerServerOptions