@typed/router

Transitions between decoded route candidates while retaining compatible mounted work.

The path, raw input, candidate list, and ambient Layers for one route update.

Creates a scoped executor for route candidate decoding and selection.

Extracts a Guard’s typed failure channel.

Extracts the successful narrowed value produced by a Guard.

Extracts the Effect services required by a Guard.

An object that supplies a Guard through an own callable asGuard property. Use an instance field rather than a prototype method.

A Guard or an object that supplies one. Guard combinators accept either form.

An effectful partial transformation.

A successful Some contains a match, a successful None means the input did not match, and an Effect failure remains in the E channel. Required services remain in R.

Combines matcher case arrays in argument order.

Composes ordered route cases into an Fx that follows the current Navigation path.

A Matcher with intentionally widened success, error, and service channels.

Extracts a Matcher’s declared error type.

Unions the errors of a Matcher tuple.

Unions the required services of a Matcher tuple.

Unions the success outputs of a Matcher tuple.

Extracts a Matcher’s required Effect services.

Extracts a Matcher’s success output type.

Constructs an integer path parameter decoded from a string.

Constructs a finite-number path parameter decoded from a string.

Constructs a named path parameter decoded by an Effect Schema Codec.

Infers the normalized path, intersected decoded parameters, and codec services of joined Routes.

Constructs a named string path-parameter Route.

Parses a route-pattern string into a typed Route.

The root slash Route.

A Route that captures an unconstrained remainder.

Constructs a Route from a Route AST and lazily memoizes its path and schemas.

A pipeable route value containing syntax, normalized path, and Effect Schemas.

A route output or parameter-dependent output function.

The value, Effect, Stream, or Fx accepted as route output.

An immutable Matcher with no registered cases.

The standalone route-registration function bound to empty.

A function that wraps matched content using reactive params.

The reactive parameters and nested content supplied to a layout.

A reactive complete-cause handler that produces fallback Fx output.

Handles the first typed failure from an Fx or Matcher.

Handles complete causes from an Fx or Matcher with a reactive Cause RefSubject.

Handles selected tagged failures and preserves unmatched variants.

Handles the first typed failure from an Fx or Matcher.

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.

A route dependency supplied as an Effect Layer or Context.

A widened Effect Layer accepted as a route dependency.

A widened Effect Context accepted as an already-built dependency.

Extracts the acquisition error of a matcher Layer dependency.

Extracts the services supplied by a matcher dependency.

Extracts the services needed to acquire a matcher Layer dependency.

Normalizes one dependency or a dependency array to a single Effect Layer.

A Route with intentionally widened path and schema parameters.

Combines decoded path and query parameter fields for a route string.

Extracts the decoded path-only parameter record from a Route.

Extracts the decoded query-only parameter record from a Route.

A Route with intentionally widened path and schema parameters.

Extracts services required to decode a Route’s parameters.

Extracts services required to encode a Route’s parameters.

Combines decoded path and query parameter fields for a route string.

Extracts the literal path string type from a Route.

Extracts the decoded path-only parameter record from a Route.

Extracts the decoded query-only parameter record from a Route.

Extracts the combined parameter Codec from a Route.

Extracts the decoded parameter type from a Route.

Extracts the decoded parameter type from a Route.

The service requirements shared by every Typed router runtime.

Builds a browser Router Layer over the platform History API.

Builds an SSR Router Layer from an in-memory history snapshot or initial URL.

Reports route registration or parameter/query decoding failure.

Reports that every decoded candidate’s guard failed or returned None.

Reports that path lookup produced no registered candidate.

The ambient route context for the current routing boundary.

Describes the stable route mount tree visible to a running handler or layout.

Extracts the typed error channel from a Guard or Guard adapter.

Extracts the accepted input type from a Guard or Guard adapter.

Extracts the matched output type from a Guard or Guard adapter.

Extracts the Effect service requirements from a Guard or Guard adapter.