readJournal

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

Rôle et comportement

Renvoie les événements d’un journal dans l’ordre chronologique, en lisant son index exactement à reference.revision. Échoue avec TransportConflict si l’index a changé ou si un segment manque, et avec une erreur sur un cycle ou au-delà de maxEntries ou maxBytes.

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

Paramètres et propriétés

optionsRequis
ReadJournalOptions
Transport, révision exacte de l’index du journal et limite de parcours.
options.referenceRequis
TransportReference
Référence de l’index du journal, en général DispatchResult.logReference ; l’index doit encore avoir cette révision.
options.maxEntriesOptionnel
number | undefined
Nombre maximal d’événements à lire, 100000 par défaut ; une chaîne plus longue est refusée.
options.maxBytesOptionnel
number | undefined
Total d’octets des segments d’événements à lire, 64 Mio par défaut ; un dépassement est refusé.
options.transporterRequis
Transport
Transport objet appartenant à l’appelant, utilisé par le store ou l’opération. Fermer un workflow ou une sandbox ne ferme pas ce transport.

Retour

Promise<readonly unknown[]>

Signature

export declare function readJournal(
  options: ReadJournalOptions,
): Promise<readonly unknown[]>;

Contrats associés

ReadJournalOptions