Type Alias: JourneyEventPayloads<TContext, TStepId, TSnap>
@rxova/journey-react / JourneyEventPayloads
type JourneyEventPayloads<TContext, TStepId, TSnap> = object;Defined in: core/src/core/types.ts:315
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
TContext | - |
TStepId extends string | - |
TSnap | JourneySnapshot<TContext, TStepId> |
Properties
Section titled “Properties”contextChange
Section titled “contextChange”contextChange: object;Defined in: core/src/core/types.ts:336
current
Section titled “current”readonly current: TContext;previous
Section titled “previous”readonly previous: TContext;snapshot
Section titled “snapshot”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.
snapshot
Section titled “snapshot”readonly snapshot: TSnap;stepId
Section titled “stepId”readonly stepId: TStepId | null;navigationBlocked
Section titled “navigationBlocked”navigationBlocked: object;Defined in: core/src/core/types.ts:341
error?
Section titled “error?”readonly optional error?: unknown;readonly from: TStepId | null;reason
Section titled “reason”readonly reason: NavigationFailureReason;snapshot
Section titled “snapshot”readonly snapshot: TSnap;readonly to: TStepId | null;statusChange
Section titled “statusChange”statusChange: object;Defined in: core/src/core/types.ts:331
current
Section titled “current”readonly current: JourneyStatus;previous
Section titled “previous”readonly previous: JourneyStatus;snapshot
Section titled “snapshot”readonly snapshot: TSnap;stepEnter
Section titled “stepEnter”stepEnter: object;Defined in: core/src/core/types.ts:320
direction
Section titled “direction”readonly direction: StepEnterDirection;readonly from: TStepId | null;snapshot
Section titled “snapshot”readonly snapshot: TSnap;readonly to: TStepId;stepLeave
Section titled “stepLeave”stepLeave: object;Defined in: core/src/core/types.ts:326
readonly from: TStepId;snapshot
Section titled “snapshot”readonly snapshot: TSnap;readonly to: TStepId;