Module / v1.0.0-beta.13

@typed/router/Route

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

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

Parameter codecs

  • Int

    variable

    Constructs an integer path parameter decoded from a string.

  • Number

    variable

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

  • ParamWithSchema

    variable

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

Route composition

  • Join

    type-alias

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

Route construction

  • Param

    variable

    Constructs a named string path-parameter Route.

  • Parse

    variable

    Parses a route-pattern string into a typed Route.

  • Slash

    variable

    The root slash Route.

  • Wildcard

    variable

    A Route that captures an unconstrained remainder.

  • make

    function

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

Route contracts

  • Route

    interface

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

Route type inference

  • Any

    type-alias

    A Route with intentionally widened path and schema parameters.

  • Params

    type-alias

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

  • PathType

    type-alias

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

  • QueryType

    type-alias

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

  • Route.Any

    type-alias

    A Route with intentionally widened path and schema parameters.

  • Route.DecodingServices

    type-alias

    Extracts services required to decode a Route’s parameters.

  • Route.EncodingServices

    type-alias

    Extracts services required to encode a Route’s parameters.

  • Route.Params

    type-alias

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

  • Route.Path

    type-alias

    Extracts the literal path string type from a Route.

  • Route.PathType

    type-alias

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

  • Route.QueryType

    type-alias

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

  • Route.Schema

    type-alias

    Extracts the combined parameter Codec from a Route.

  • Route.Type

    type-alias

    Extracts the decoded parameter type from a Route.

  • Type

    type-alias

    Extracts the decoded parameter type from a Route.