Candidate guards
GuardErrortype-alias
Extracts a Guard’s typed failure channel.
GuardOutputtype-alias
Extracts the successful narrowed value produced by a Guard.
GuardServicestype-alias
Extracts the Effect services required by a Guard.
Guard contracts
AsGuardinterface · Re-export
An object that supplies a Guard through an own callable
asGuardproperty. Use an instance field rather than a prototype method.GuardInputtype-alias · Re-export
A Guard or an object that supplies one. Guard combinators accept either form.
GuardTypetype-alias · Re-export
An effectful partial transformation.
A successful
Somecontains a match, a successfulNonemeans the input did not match, and an Effect failure remains in theEchannel. Required services remain inR.
Matcher composition
mergefunction
Combines matcher case arrays in argument order.
Matcher contracts
Matcherinterface
Composes ordered route cases into an Fx that follows the current Navigation path.
Matcher.Anytype-alias
A Matcher with intentionally widened success, error, and service channels.
Matcher type inference
Matcher.Errortype-alias
Extracts a Matcher’s declared error type.
Matcher.MergeErrortype-alias
Unions the errors of a Matcher tuple.
Matcher.MergeServicestype-alias
Unions the required services of a Matcher tuple.
Matcher.MergeSuccesstype-alias
Unions the success outputs of a Matcher tuple.
Matcher.Servicestype-alias
Extracts a Matcher’s required Effect services.
Matcher.Successtype-alias
Extracts a Matcher’s success output type.
Route handlers
MatchHandlertype-alias
A route output or parameter-dependent output function.
MatchHandlerReturnValuetype-alias
The value, Effect, Stream, or Fx accepted as route output.
emptyvariable
An immutable Matcher with no registered cases.
matchvariable
The standalone route-registration function bound to
empty.
Route layouts
Layouttype-alias
A function that wraps matched content using reactive params.
LayoutParamstype-alias
The reactive parameters and nested content supplied to a layout.
Route recovery
CatchHandlertype-alias
A reactive complete-cause handler that produces fallback Fx output.
catchvariable · Re-export
Handles the first typed failure from an Fx or Matcher.
catchCausevariable
Handles complete causes from an Fx or Matcher with a reactive Cause RefSubject.
catchTagvariable
Handles selected tagged failures and preserves unmatched variants.
catch_variable
Handles the first typed failure from an Fx or Matcher.
redirectTovariable
Retries a Matcher or Fx once after navigating on
RouteNotFound.Prefer the fluent
matcher.redirectTo(path)method when configuring a Matcher. This standalone form remains useful for inputs already expressed as Fx and for existing data-last pipelines.
Route services
AnyDependencytype-alias
A route dependency supplied as an Effect Layer or Context.
AnyLayertype-alias
A widened Effect Layer accepted as a route dependency.
AnyServiceMaptype-alias
A widened Effect Context accepted as an already-built dependency.
DependencyErrortype-alias
Extracts the acquisition error of a matcher Layer dependency.
DependencyProvidedtype-alias
Extracts the services supplied by a matcher dependency.
DependencyRequirementstype-alias
Extracts the services needed to acquire a matcher Layer dependency.
normalizeDependencyInputfunction
Normalizes one dependency or a dependency array to a single Effect Layer.
Selection errors
RouteDecodeErrorclass · Re-export
Reports route registration or parameter/query decoding failure.
RouteGuardErrorclass · Re-export
Reports that every decoded candidate’s guard failed or returned
None.RouteNotFoundclass · Re-export
Reports that path lookup produced no registered candidate.
Type utilities
GuardType.Errortype-alias · Re-export
Extracts the typed error channel from a Guard or Guard adapter.
GuardType.Inputtype-alias · Re-export
Extracts the accepted input type from a Guard or Guard adapter.
GuardType.Outputtype-alias · Re-export
Extracts the matched output type from a Guard or Guard adapter.
GuardType.Servicestype-alias · Re-export
Extracts the Effect service requirements from a Guard or Guard adapter.