Rxova
Skip to content

Type Alias: LinearJourneyBundleDefinition<TContext, TSteps>

@rxova/journey-react


@rxova/journey-react / LinearJourneyBundleDefinition

type LinearJourneyBundleDefinition<TContext, TSteps> = object;

Defined in: react/src/react.types.ts:271

The pure-data definition createLinearJourney() captures: core’s own LinearJourneyDefinition shape, minus the step lifecycle hooks. Step metadata lives here — never in JSX; enter and leave are a useEffect with a cleanup in the step’s own view.

Type ParameterDefault type
TContext-
TSteps extends readonly ReactLinearStepInput<TContext, unknown>[]readonly [ReactLinearStepInput<TContext, unknown>, ...ReactLinearStepInput<TContext, unknown>[]]
readonly context: TContext;

Defined in: react/src/react.types.ts:281

Initial shared state and the bundle’s context type anchor.


readonly optional name?: string;

Defined in: react/src/react.types.ts:283

Optional bundle name, used for the Provider’s React DevTools displayName.


readonly steps: TSteps;

Defined in: react/src/react.types.ts:279

Ordered steps — the machine’s source of truth. A bare string is shorthand for { id }.