Function createTravels

Returns {
    getRevision: () => number;
    getState: () => S;
    mutable: boolean;
    subscribe: (listener: (event: TravelsEvent<S, P>) => void) => () => void;
    assertPersistenceCompatible(): void;
    back(amount?: number): void;
    batch<FN extends () => unknown>(
        metadata: TravelMetadata,
        fn: FN & () => unknown,
    ): void;
    batch<FN extends () => unknown>(fn: FN & () => unknown): void;
    canBack(): boolean;
    canForward(): boolean;
    forward(amount?: number): void;
    getControls(): RebasableTravelsControls<S, P>;
    getHistory(): readonly Immutable<S>[];
    getHistoryEntries(): TravelHistoryEntry<P>[];
    getHistorySnapshot(): S[];
    getMetadata(): (undefined | TravelMetadata)[];
    getPatches(): TravelPatches<P>;
    getPosition(): number;
    go(nextPosition: number): void;
    pauseTracking(): void;
    rebase(): void;
    replaceStateWithoutHistory<U>(updater: {}): void;
    reset(): void;
    resumeTracking(): void;
    serialize(
        options?: TravelsSerializeOptions,
    ): TravelsSerializedHistory<S, P>;
    setState<U>(updater: {}, metadata?: TravelMetadata): void;
    transaction<FN extends () => unknown>(
        metadata: TravelMetadata,
        fn: FN & () => unknown,
    ): void;
    transaction<FN extends () => unknown>(fn: FN & () => unknown): void;
}

• ReadonlygetRevision: () => number

  Monotonic token for committed observable timeline transitions.

• ReadonlygetState: () => S

  Borrowed live state, the same value observers receive as event.state.

  Remarks

  Typed as S so it can flow into stores and APIs that expect the state type, but it must be treated as read-only: history patches apply to this value, so mutating it outside Travels operations desynchronizes undo/redo. In immutable mode its objects are also the values of retained patches, so such a mutation rewrites the history that redo replays. enableAutoFreeze freezes every state Travels produces after creation.

• Readonlymutable: boolean

• Readonlysubscribe: (listener: (event: TravelsEvent<S, P>) => void) => () => void

• assertPersistenceCompatible: function

  • assertPersistenceCompatible(): void

    Returns void

• back: function

  • back(amount?: number): void

    Parameters

    • Optionalamount: number

    Returns void

• batch: function

  • batch<FN extends () => unknown>(
        metadata: TravelMetadata,
        fn: FN & () => unknown,
    ): void

    Type Parameters

    • FN extends () => unknown

    Parameters

    • metadata: TravelMetadata
    • fn: FN & () => unknown

    Returns void

  • batch<FN extends () => unknown>(fn: FN & () => unknown): void

    Type Parameters

    • FN extends () => unknown

    Parameters

    • fn: FN & () => unknown

    Returns void

• canBack: function

  • canBack(): boolean

    Returns boolean

• canForward: function

  • canForward(): boolean

    Returns boolean

• forward: function

  • forward(amount?: number): void

    Parameters

    • Optionalamount: number

    Returns void

• getControls: function

  • getControls(): RebasableTravelsControls<S, P>

    Returns RebasableTravelsControls<S, P>

• getHistory: function

  • getHistory(): readonly Immutable<S>[]

    Returns readonly Immutable<S>[]

• getHistoryEntries: function

  • getHistoryEntries(): TravelHistoryEntry<P>[]

    Returns TravelHistoryEntry<P>[]

• getHistorySnapshot: function

  • getHistorySnapshot(): S[]

    Returns S[]

• getMetadata: function

  • getMetadata(): (undefined | TravelMetadata)[]

    Returns (undefined | TravelMetadata)[]

• getPatches: function

  • getPatches(): TravelPatches<P>

    Returns TravelPatches<P>

• getPosition: function

  • getPosition(): number

    Returns number

• go: function

  • go(nextPosition: number): void

    Parameters

    • nextPosition: number

    Returns void

• pauseTracking: function

  • pauseTracking(): void

    Returns void

• rebase: function

  • rebase(): void

    Returns void

• replaceStateWithoutHistory: function

  • replaceStateWithoutHistory<U>(updater: {}): void

    Type Parameters

    • U

    Parameters

    • updater: {}

    Returns void

• reset: function

  • reset(): void

    Returns void

• resumeTracking: function

  • resumeTracking(): void

    Returns void

• serialize: function

  • serialize(options?: TravelsSerializeOptions): TravelsSerializedHistory<S, P>

    Parameters

    • Optionaloptions: TravelsSerializeOptions

    Returns TravelsSerializedHistory<S, P>

• setState: function

  • setState<U>(updater: {}, metadata?: TravelMetadata): void

    Type Parameters

    • U

    Parameters

    • updater: {}
    • Optionalmetadata: TravelMetadata

    Returns void

• transaction: function

  • transaction<FN extends () => unknown>(
        metadata: TravelMetadata,
        fn: FN & () => unknown,
    ): void

    Type Parameters

    • FN extends () => unknown

    Parameters

    • metadata: TravelMetadata
    • fn: FN & () => unknown

    Returns void

  • transaction<FN extends () => unknown>(fn: FN & () => unknown): void

    Type Parameters

    • FN extends () => unknown

    Parameters

    • fn: FN & () => unknown

    Returns void

Returns Travels<S, F, false, P>

Returns Travels<S, F, A, P>