Type Alias TravelJournal<S, F, A, P>

TravelJournal: Readonly<
    Pick<
        Travels<S, F, A, P>,

            | "subscribe"
            | "getState"
            | "getRevision"
            | "getHistory"
            | "getHistorySnapshot"
            | "go"
            | "back"
            | "forward"
            | "reset"
            | "rebase"
            | "canBack"
            | "canForward"
            | "getPosition"
            | "getPatches"
            | "serialize"
            | "assertPersistenceCompatible"
            | "getMetadata"
            | "getHistoryEntries",
    > & { recordPatches: (state: S, entry: TravelHistoryEntry<P>) => void } & (
        A extends false
            ? {
                archive: (metadata?: TravelMetadata) => void;
                canArchive: () => boolean;
            }
            : {}
    ),
>

Public surface for a timeline whose state is owned by another runtime.

State-owning methods such as setState(), transactions, tracking controls, and getControls() are intentionally excluded. External commits enter through recordPatches(); navigation and reset leave through apply.

Type Parameters

S
F extends boolean = false
A extends boolean = true
P extends PatchesOption = {}

Type Alias TravelJournal<S, F, A, P>

Type Parameters

Settings