travels
    Preparing search index...

    Type Alias TravelsOptions<F, A, P>

    TravelsOptions: {
        autoArchive?: A;
        controlledApply?: TravelsControlledApply<any, P>;
        devtools?: (event: TravelsEvent<any, P>) => void;
        history?: TravelsHistory<P>;
        initialPatches?: TravelPatches<P>;
        initialPosition?: number;
        maxHistory?: number;
        mutable?: boolean;
        onBranchDiscard?: (event: TravelsBranchDiscardEvent<P>) => void;
        onError?: (error: Error) => void;
        onObserverError?: (event: TravelsObserverErrorEvent) => void;
        onWarning?: (warning: TravelsWarning) => void;
        strictInitialPatches?: boolean;
        warnOnUnsupportedState?: boolean;
    } & Omit<MutativeOptions<true, F>, "enablePatches"> & { patchesOptions?: P }

    Type Parameters

    Type Declaration

    • OptionalautoArchive?: A

      Whether to automatically archive the current state, by default true

    • OptionalcontrolledApply?: TravelsControlledApply<any, P>

      Delegate history navigation to an external authoritative state owner.

      Intended for integration adapters created with createTravelJournal(). The callback runs before Travels moves its cursor. If it throws, the Travels state and position remain unchanged.

    • Optionaldevtools?: (event: TravelsEvent<any, P>) => void

      Optional hook for external devtools or debugging timelines.

    • Optionalhistory?: TravelsHistory<P>

      Restore validated serialized history. This is equivalent to passing initialPatches and initialPosition directly, but preserves the first-class persistence API shape returned by Travels.deserialize(...).

    • OptionalinitialPatches?: TravelPatches<P>

      The initial patches of the history

    • OptionalinitialPosition?: number

      The initial position in the history, by default 0

    • OptionalmaxHistory?: number

      The maximum number of history to keep, by default 10

    • Optionalmutable?: boolean

      Whether to mutate the state in place (for observable state like MobX, Vue, Pinia) When true, apply patches directly to the existing state object When false (default), create new immutable state objects

      false
    • OptionalonBranchDiscard?: (event: TravelsBranchDiscardEvent<P>) => void

      Called when undoing and then making a committed edit discards redo history. Root transactions report only entries that were visible before they began.

    • OptionalonError?: (error: Error) => void

      Called when Travels wraps a thrown core operation error. Errors raised by nested transactions are published after the root transaction settles.

    • OptionalonObserverError?: (event: TravelsObserverErrorEvent) => void

      Receives errors thrown by notification hooks. Observer errors never roll back or interrupt an already committed state transition.

    • OptionalonWarning?: (warning: TravelsWarning) => void

      Receives non-fatal normalization, compatibility, and migration warnings. Without this hook warnings are written to the console only in development.

    • OptionalstrictInitialPatches?: boolean

      Whether to throw when initialPatches is invalid. When false (default), invalid patches are discarded and history starts empty.

    • OptionalwarnOnUnsupportedState?: boolean

      Warn in development about weak patch or JSON persistence semantics in state, retained patches, or history metadata. Defaults to true.

    • OptionalpatchesOptions?: P

      Configure patch formatting. Patches cannot be disabled because Travels uses them to implement history, navigation, and persistence.

    Settings

    Member Visibility