Rxova
Skip to content

Type Alias: NavigationResult<TStepId>

@rxova/journey-react


@rxova/journey-react / NavigationResult

type NavigationResult<TStepId> =
| {
from: TStepId | null;
ok: true;
to: TStepId;
}
| {
error?: unknown;
from: TStepId | null;
ok: false;
reason: NavigationFailureReason;
to: TStepId | null;
};

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

Result of every navigation verb (and of graph send).

The failure arm carries from/to so a caller awaiting the result can log which target was rejected without also subscribing to navigationBlocked. to is null when the machine never resolved one — a graph send with no enabled candidate, for instance.

Type ParameterDefault type
TStepId extends stringstring