Function: createLinearJourney()

@rxova/journey-core / createLinearJourney

function createLinearJourney<TStepId, TContext, TTerminationPayloads, TPlugins, TMeta>(definition, options?): LinearJourneyMachine<TContext, TStepId, TMeta, TPlugins, CompletePayloadOf<TTerminationPayloads>, TerminatePayloadOf<TTerminationPayloads>>;

Defined in: packages/core/src/linear/linear.ts:26

Creates a linear journey runtime from a pure-data definition.

Declared order drives goToNextStep’s fallback at the timeline tip and the order-based snapshot fields (index, isFirstStep, isLastStep, stepOrder). goToNextStep on the last step never auto-completes.

Type Parameters

Type Parameter	Default type
`TStepId` extends `string`	-
`TContext`	-
`TTerminationPayloads` extends `JourneyTerminationPayloads`	`JourneyTerminationPayloads`
`TPlugins` extends readonly `AnyJourneyPlugin`[]	readonly []
`TMeta`	`Record`<`string`, `unknown`>

Parameters

Parameter	Type
`definition`	`LinearJourneyDefinition`<`TStepId`, `TContext`, `TTerminationPayloads`, `TMeta`>
`options`	`JourneyRuntimeOptions`<`TPlugins`, `NoInfer`<`TStepId`>>

Returns

LinearJourneyMachine<TContext, TStepId, TMeta, TPlugins, CompletePayloadOf<TTerminationPayloads>, TerminatePayloadOf<TTerminationPayloads>>