Module / v1.0.0-beta.13

@typed/router/AST

31 unique exports available through this public import path, including their members and aliases.

import * as AST from "@typed/router/AST";

Matcher composition syntax

  • MatchAst.Catch

    interface

    A Match AST node defining a reactive cause boundary.

  • MatchAst.Layer

    interface

    A Match AST boundary carrying route-local Effect Layers.

  • MatchAst.Layout

    interface

    A function that wraps matched content using reactive params.

  • MatchAst.Prefixed

    interface

    A Match AST node that structurally prefixes nested cases.

  • MatchAst.Route

    interface

    A Match AST candidate containing one Route AST, Guard, and output handler.

  • catchCause

    variable

    Constructs a Match AST complete-cause boundary.

  • layer

    variable

    Wraps Match AST nodes with Effect Layer dependencies.

  • layout

    variable

    Constructs a Match AST boundary around a parameter-aware layout.

  • prefixed

    variable

    Wraps Match AST nodes with a structural Route prefix.

  • route

    variable

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

Path syntax

  • PathAst

    type-alias

    The union of path, parameter, wildcard, slash, and query AST nodes.

  • PathAst.Literal

    type-alias

    An exact literal path or query-value AST node.

  • PathAst.Parameter

    type-alias

    A named path parameter with optionality and an optional regular expression.

  • PathAst.QueryParam

    type-alias

    One named query key and its literal or parameter value AST.

  • PathAst.QueryParams

    type-alias

    A collection of declared query-parameter AST nodes.

  • PathAst.Slash

    type-alias

    The root slash Route.

  • PathAst.Wildcard

    type-alias

    A Route that captures an unconstrained remainder.

  • RouteAst

    type-alias

    The union of path, schema-transform, and joined route nodes.

  • literal

    variable

    Constructs an exact literal Path AST node.

  • parameter

    variable

    Constructs a named parameter Path AST node with optional and regex constraints.

  • queryParam

    variable

    Constructs one named query-parameter AST node.

  • queryParams

    variable

    Constructs a query-parameter collection Path AST node.

  • slash

    variable

    Constructs a root slash Path AST node.

  • wildcard

    variable

    Constructs a terminal wildcard Path AST node.

Route structure

  • MatchAst

    type-alias

    The union of route, dependency, layout, prefix, and catch matcher nodes.

  • RouteAst.Join

    interface

    A Route AST node containing ordered child routes.

  • RouteAst.Path

    interface

    A Route AST node containing one Path AST atom.

  • RouteAst.Transform

    interface

    A Route AST node carrying an Effect Schema transformation.

  • join

    variable

    Constructs an ordered joined Route AST node.

  • path

    variable

    Constructs a Route AST node from one Path AST atom.

  • transform

    variable

    Constructs a schema-transforming Route AST node.