Rxova
Skip to content

Type Alias: JourneyEventPayloads<TContext, TStepId, TSnap>

@rxova/journey-react


@rxova/journey-react / JourneyEventPayloads

type JourneyEventPayloads<TContext, TStepId, TSnap> = object;

Defined in: core/src/core/types.ts:315

Type ParameterDefault type
TContext-
TStepId extends string-
TSnapJourneySnapshot<TContext, TStepId>
contextChange: object;

Defined in: core/src/core/types.ts:336

readonly current: TContext;
readonly previous: TContext;
readonly snapshot: TSnap;

error: object;

Defined in: core/src/core/types.ts:348

readonly error: unknown;
readonly phase: "work" | "leave" | "enter" | "transition" | "raise";

Which pipeline stage threw.

readonly snapshot: TSnap;
readonly stepId: TStepId | null;

navigationBlocked: object;

Defined in: core/src/core/types.ts:341

readonly optional error?: unknown;
readonly from: TStepId | null;
readonly reason: NavigationFailureReason;
readonly snapshot: TSnap;
readonly to: TStepId | null;

statusChange: object;

Defined in: core/src/core/types.ts:331

readonly current: JourneyStatus;
readonly previous: JourneyStatus;
readonly snapshot: TSnap;

stepEnter: object;

Defined in: core/src/core/types.ts:320

readonly direction: StepEnterDirection;
readonly from: TStepId | null;
readonly snapshot: TSnap;
readonly to: TStepId;

stepLeave: object;

Defined in: core/src/core/types.ts:326

readonly from: TStepId;
readonly snapshot: TSnap;
readonly to: TStepId;