travels
    Preparing search index...

    Type Alias TravelsEvent<S, P>

    type TravelsEvent<S, P extends PatchesOption = {}> = {
        historyLength: number;
        metadata?: Readonly<TravelMetadata>;
        patches: ReadonlyTravelPatches<P>;
        position: number;
        state: ReadonlyState<S>;
        type: TravelsEventType;
    }

    Type Parameters

    Index

    Properties

    historyLength metadata? patches position state type

    Properties

    historyLength: number

    Number of entries currently retained in history.

    metadata?: Readonly<TravelMetadata>

    Lazily cloned, shallow-frozen metadata shared by this event's observers.

    patches: ReadonlyTravelPatches<P>

    Lazily materialized event-local patches that transform the previously published state. Treat the shared snapshot as read-only.

    position: number
    state: ReadonlyState<S>

    Borrowed live state view. Mutate state only through Travels operations.

    type: TravelsEventType

    The committed operation. Handle unrecognized values in a default branch.

    Settings

    Member Visibility

    On This Page

    Properties