Type Alias TravelsEvent<S, P>

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

Type Parameters

S
P extends PatchesOption = {}

Index

Properties

historyLength metadata? patches position state type

Properties

`Readonly`historyLength

historyLength: number

Number of entries currently retained in history.

`Optional` `Readonly`metadata

metadata?: TravelMetadata

`Readonly`patches

patches: TravelPatches<P>

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

`Readonly`position

position: number

`Readonly`state

state: S

`Readonly`type

type: TravelsEventType

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