Module / v1.0.0-beta.7

@typed/router/Path

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

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

Parameter inference

  • Params

    type-alias

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

  • PathParams

    type-alias

    Extracts decoded path-parameter fields from a route string.

  • QueryParams

    type-alias

    Extracts decoded query-parameter fields from a route string.

Parameter schemas

  • OptionalSchemaField

    type-alias

    An optional schema record key paired with its Effect Schema.

  • SchemaField

    type-alias

    A required decoded field name paired with its Effect Schema.

  • SchemaFields

    type-alias

    The required, optional, and per-query schema fields derived from Path AST nodes.

  • getSchemaFields

    function

    Collects route schema fields from ordered Path AST nodes.

  • getSchemas

    function

    Builds combined, path-only, and query-only schemas from Path AST nodes.

  • schemaForQueryValue

    function

    Builds the decoder for one declared query value AST.

  • schemaFromFields

    function

    Builds an Effect Schema record from required and optional route fields.

Path formatting

  • Join

    type-alias

    Formats a tuple of Path AST nodes as its normalized route string literal type.

  • join

    function

    Formats ordered Path AST nodes as a normalized route string.

Path parsing

  • ParseAsts

    type-alias

    Parses a route string literal into its ordered Path AST tuple.

  • PathParser

    type-alias

    The type-level parser for one route path atom after optional slashes.

  • RuntimeParseResult

    type-alias

    A runtime AST list paired with the unconsumed route suffix.

  • parse

    function

    Parses a complete route string into Path AST nodes.

  • parseWithRest

    function

    Parses route atoms and returns both AST nodes and unconsumed input.

Query decoding

Route structure validation