Type Alias TravelsControlledTransition<S, P>

Patch transition delegated to an external state owner by a controlled Travels journal.

type TravelsControlledTransition<S, P extends PatchesOption = {}> = {
    fromPosition: number;
    inversePatches: Patches<P>;
    patches: Patches<P>;
    state: S;
    toPosition: number;
}

Type Parameters

S
P extends PatchesOption = {}

Index

Properties

fromPosition inversePatches patches state toPosition

Properties

`Readonly`fromPosition

fromPosition: number

`Readonly`inversePatches

inversePatches: Patches<P>

Composed patches that roll the transition back.

`Readonly`patches

patches: Patches<P>

Composed patches that move from fromPosition to toPosition.

`Readonly`state

state: S

State known to Travels before the transition is applied.

`Readonly`toPosition

toPosition: number