Type Alias: GraphSnapshot<TContext, TStepId, TMeta, TEvents, TCompletePayload, TTerminatePayload>
@rxova/journey-react / GraphSnapshot
type GraphSnapshot<TContext, TStepId, TMeta, TEvents, TCompletePayload, TTerminatePayload> = Omit<JourneySnapshotBase<TContext, TStepId, TMeta, TCompletePayload, TTerminatePayload>, "currentStep"> & object;Defined in: core/src/core/types.ts:178
Graph snapshots carry declared and enabled transition derivations; order fields don’t exist.
Type Declaration
Section titled “Type Declaration”availableEvents
Section titled “availableEvents”readonly availableEvents: readonly TEvents["type"][];Events with at least one enabled candidate from the current step.
availableSteps
Section titled “availableSteps”readonly availableSteps: readonly TStepId[];Targets of enabled candidates from the current step.
currentStep
Section titled “currentStep”readonly currentStep: CurrentStepBase<TStepId, TMeta> & object | null;declaredEvents
Section titled “declaredEvents”readonly declaredEvents: readonly TEvents["type"][];Event names declared by outgoing candidates from the current step.
outgoingTransitions
Section titled “outgoingTransitions”readonly outgoingTransitions: readonly GraphTransitionSnapshot<TStepId, TEvents["type"]>[];Guard and selection state for every outgoing candidate from the current step.
readonly steps: object;steps.totalSteps
Section titled “steps.totalSteps”readonly totalSteps: number;steps.visitedStepCount
Section titled “steps.visitedStepCount”readonly visitedStepCount: number;readonly type: "graph";Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
TContext | - |
TStepId extends string | - |
TMeta | - |
TEvents extends JourneyEventObject | JourneyEventObject |
TCompletePayload | unknown |
TTerminatePayload | unknown |