{
  "id": "@typed/router/Route#Parse",
  "canonicalId": "@typed/router#Parse",
  "symbol": {
    "id": "@typed/router/Route#Parse",
    "packageName": "@typed/router",
    "moduleName": "Route",
    "exportName": "Parse",
    "kind": "constant",
    "signatures": [
      "export declare const Parse: <const P extends string>(path: P) => Route<Path.Join<Path.ParseAsts<P>>>;"
    ],
    "summary": "Parses a route-pattern string into a typed Route.",
    "sections": {
      "Why": "It is the primary constructor for literals, named parameters, optional parameters, regular-\nexpression parameters, wildcards, and query declarations. The special `??` boundary separates a\nterminal optional path parameter from query syntax.",
      "Ownership and lifetime": "`Parse` constructs its Route immediately. The Route retains the supplied AST or route values and lazily memoizes derived paths and Codecs; Codec services are required only when decoding or encoding runs."
    },
    "examples": [
      {
        "language": "ts",
        "code": "import * as Router from \"@typed/router\"\n\nconst User = Router.Parse(\"/users/:id?tab=:tab?\")\n// Router.Type<typeof User> is { readonly id: string; readonly tab?: string }"
      }
    ],
    "relations": [],
    "source": {
      "file": "packages/router/src/Route.ts",
      "line": 497
    },
    "since": "1.0.0",
    "category": "Route construction"
  },
  "exposure": {
    "recordKind": "declaration",
    "id": "@typed/router/Route#Parse",
    "packageName": "@typed/router",
    "packageVersion": "1.0.0-beta.7",
    "moduleName": "Route",
    "consumerSpecifier": "@typed/router/Route",
    "exportName": "Parse",
    "qualifiedName": "Parse",
    "declarationKey": "declaration:c274516522099d5125dde8a2",
    "family": "variable",
    "signatures": [
      "export declare const Parse: <const P extends string>(path: P) => Route<Path.Join<Path.ParseAsts<P>>>;"
    ],
    "sourceSpans": [
      {
        "file": "packages/router/src/Route.ts",
        "start": {
          "line": 497,
          "column": 14
        },
        "end": {
          "line": 504,
          "column": 2
        }
      }
    ],
    "aliases": [
      "@typed/router#Parse"
    ],
    "isAlias": false,
    "static": false
  },
  "declaration": {
    "declarationKey": "declaration:c274516522099d5125dde8a2",
    "name": "Parse",
    "family": "variable",
    "facets": [
      {
        "family": "variable",
        "syntaxKind": "VariableDeclaration",
        "signatures": [
          "export declare const Parse: <const P extends string>(path: P) => Route<Path.Join<Path.ParseAsts<P>>>;"
        ],
        "typeParameters": [],
        "sourceSpans": [
          {
            "file": "packages/router/src/Route.ts",
            "start": {
              "line": 497,
              "column": 14
            },
            "end": {
              "line": 504,
              "column": 2
            }
          }
        ],
        "static": false,
        "readonly": false,
        "optional": false
      }
    ],
    "signatures": [
      "export declare const Parse: <const P extends string>(path: P) => Route<Path.Join<Path.ParseAsts<P>>>;"
    ],
    "typeParameters": [],
    "summary": "Parses a route-pattern string into a typed Route.",
    "sections": {
      "Why": "It is the primary constructor for literals, named parameters, optional parameters, regular-\nexpression parameters, wildcards, and query declarations. The special `??` boundary separates a\nterminal optional path parameter from query syntax.",
      "Ownership and lifetime": "`Parse` constructs its Route immediately. The Route retains the supplied AST or route values and lazily memoizes derived paths and Codecs; Codec services are required only when decoding or encoding runs."
    },
    "examples": [
      {
        "language": "ts",
        "code": "import * as Router from \"@typed/router\"\n\nconst User = Router.Parse(\"/users/:id?tab=:tab?\")\n// Router.Type<typeof User> is { readonly id: string; readonly tab?: string }"
      }
    ],
    "sourceSpans": [
      {
        "file": "packages/router/src/Route.ts",
        "start": {
          "line": 497,
          "column": 14
        },
        "end": {
          "line": 504,
          "column": 2
        }
      }
    ],
    "since": "1.0.0",
    "category": "Route construction"
  }
}