MatchAst.Route · API reference

Import

import { MatchAst } from "@typed/router/AST";

Access MatchAst.Route through the imported MatchAst export. Its declaration below describes the member.

interface Route {
    type: "route";
    route: RouteAst;
    guard: Guard<any, any, any, any>;
    handler: MatchHandler<any, any, any, any>;
}

Decoding, guard selection, and output stay attached in declaration order.

Route describes plain readonly AST data. Routes and Matchers retain the concrete nodes they receive by reference; the type itself owns no resource.

The guard evaluated after parameter decoding and dependency preparation.

A Some selects the candidate; None or failure can fall through without mounting its handler.

The guard function is retained with the candidate. Its Effect and service requirements begin only when the executor evaluates that candidate.

The output producer mounted for a selected route.

Values, Effect, Stream, and Fx all normalize to the same push-based Fx contract.

The producer is retained with the candidate; the selected route Scope owns the Fx it returns and interrupts that Fx on replacement.

Constructs a route-case Match AST node with its guard and handler.

Candidate order, decoding, guard selection, and output remain one inspectable registration unit.

The Match AST retains the immutable Route AST by reference until the Matcher becomes unreachable.

The discriminant identifying this AST variant.

Exhaustive switches can interpret syntax without instanceof checks or hidden classes.