Skip to content
v9.1.1
Français

ReadJournalOptions

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

Parameters and properties

Section titled “Parameters and properties”
  • referenceRequired
    TransportReference
    Journal index reference, usually DispatchResult.logReference; the index must still have this revision.
  • maxEntriesOptional
    number | undefined
    Most events to read, default 100000; a longer chain rejects.
  • maxBytesOptional
    number | undefined
    Total bytes of event segments to read, default 64 MiB; exceeding it rejects.
  • transporterRequired
    Transport
    Caller-owned object transport used by the store or operation. Closing a workflow or sandbox does not close this transport.

Signature

Section titled “Signature”
export interface ReadJournalOptions extends TransportStoreOptions {
  readonly reference: TransportReference;
  readonly maxEntries?: number;
  readonly maxBytes?: number;
}
Section titled “Related contracts”