PathAst

Import

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

Signatures

export type PathAst = PathAst.Literal | PathAst.Parameter | PathAst.Slash | PathAst.Wildcard | PathAst.QueryParams;

export declare namespace PathAst {
    type Literal = {
        type: "literal";
        value: string;
    };
    type Parameter = {
        type: "parameter";
        name: string;
        optional?: boolean;
        regex?: string;
    };
    type Wildcard = {
        type: "wildcard";
    };
    type Slash = {
        type: "slash";
    };
    type QueryParams = {
        type: "query-params";
        value: ReadonlyArray<PathAst.QueryParam>;
    };
    type QueryParam = {
        type: "query-param";
        name: string;
        value: PathAst;
    };
}

Why

One explicit syntax tree feeds formatting, schema derivation, and matcher compilation.

Ownership and lifetime

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

Members

• PathAst.Literal

  An exact literal path or query-value AST node.

• PathAst.Parameter

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

• PathAst.QueryParam

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

• PathAst.QueryParams

  A collection of declared query-parameter AST nodes.

• PathAst.Slash

  The root slash Route.

• PathAst.Wildcard

  A Route that captures an unconstrained remainder.

Source

• packages/router/src/AST.ts:23
• packages/router/src/AST.ts:30