{
  "id": "@typed/navigation#BeforeNavigationEvent",
  "canonicalId": "@typed/navigation#BeforeNavigationEvent",
  "symbol": {
    "id": "@typed/navigation#BeforeNavigationEvent",
    "packageName": "@typed/navigation",
    "moduleName": ".",
    "exportName": "BeforeNavigationEvent",
    "kind": "constant",
    "signatures": [
      "export declare const BeforeNavigationEvent: Schema.Struct<{\n    readonly type: Schema.Union<readonly [\n        Schema.Literal<\"push\">,\n        Schema.Literal<\"replace\">,\n        Schema.Literal<\"reload\">,\n        Schema.Literal<\"traverse\">\n    ]>;\n    readonly from: Schema.Struct<{\n        readonly id: Schema.String;\n        readonly key: Schema.String;\n        readonly url: Schema.URLFromString;\n        readonly state: Schema.Unknown;\n        readonly sameDocument: Schema.Boolean;\n    }>;\n    readonly delta: Schema.Int;\n    readonly to: Schema.Struct<{\n        readonly url: Schema.URLFromString;\n        readonly state: Schema.Unknown;\n        readonly sameDocument: Schema.Boolean;\n        readonly key: Schema.optional<Schema.String>;\n    }>;\n    readonly info: Schema.Unknown;\n}>;",
      "export type BeforeNavigationEvent = typeof BeforeNavigationEvent.Type;"
    ],
    "summary": "Describes the pre-commit event presented to navigation guards.",
    "sections": {
      "Why": "Guards need the old and proposed destinations plus traversal delta before a backend mutates\nhistory. This event is deliberately distinct from post-commit {@link NavigationEvent}.",
      "Ownership and lifetime": "The schema acquires no resources. The navigation operation owns each event until its registered\nhandlers settle; handlers must copy data they need later."
    },
    "examples": [
      {
        "language": "ts",
        "code": "import { BeforeNavigationEvent } from \"@typed/navigation/model\"\nimport * as Schema from \"effect/Schema\"\n\nconst isBeforeEvent = Schema.is(BeforeNavigationEvent)"
      }
    ],
    "relations": [],
    "source": {
      "file": "packages/navigation/src/model.ts",
      "line": 199
    },
    "since": "1.0.0",
    "category": "Navigation event schemas"
  },
  "exposure": {
    "recordKind": "declaration",
    "id": "@typed/navigation#BeforeNavigationEvent",
    "packageName": "@typed/navigation",
    "packageVersion": "1.0.0-beta.7",
    "moduleName": ".",
    "consumerSpecifier": "@typed/navigation",
    "exportName": "BeforeNavigationEvent",
    "qualifiedName": "BeforeNavigationEvent",
    "declarationKey": "declaration:c665d831e6a04b42e57df6a3",
    "family": "variable",
    "signatures": [
      "export declare const BeforeNavigationEvent: Schema.Struct<{\n    readonly type: Schema.Union<readonly [\n        Schema.Literal<\"push\">,\n        Schema.Literal<\"replace\">,\n        Schema.Literal<\"reload\">,\n        Schema.Literal<\"traverse\">\n    ]>;\n    readonly from: Schema.Struct<{\n        readonly id: Schema.String;\n        readonly key: Schema.String;\n        readonly url: Schema.URLFromString;\n        readonly state: Schema.Unknown;\n        readonly sameDocument: Schema.Boolean;\n    }>;\n    readonly delta: Schema.Int;\n    readonly to: Schema.Struct<{\n        readonly url: Schema.URLFromString;\n        readonly state: Schema.Unknown;\n        readonly sameDocument: Schema.Boolean;\n        readonly key: Schema.optional<Schema.String>;\n    }>;\n    readonly info: Schema.Unknown;\n}>;",
      "export type BeforeNavigationEvent = typeof BeforeNavigationEvent.Type;"
    ],
    "sourceSpans": [
      {
        "file": "packages/navigation/src/model.ts",
        "start": {
          "line": 199,
          "column": 14
        },
        "end": {
          "line": 205,
          "column": 3
        }
      },
      {
        "file": "packages/navigation/src/model.ts",
        "start": {
          "line": 219,
          "column": 1
        },
        "end": {
          "line": 219,
          "column": 71
        }
      }
    ],
    "aliases": [
      "@typed/navigation/model#BeforeNavigationEvent"
    ],
    "isAlias": false,
    "static": false
  },
  "declaration": {
    "declarationKey": "declaration:c665d831e6a04b42e57df6a3",
    "name": "BeforeNavigationEvent",
    "family": "variable",
    "facets": [
      {
        "family": "variable",
        "syntaxKind": "VariableDeclaration",
        "signatures": [
          "export declare const BeforeNavigationEvent: Schema.Struct<{\n    readonly type: Schema.Union<readonly [\n        Schema.Literal<\"push\">,\n        Schema.Literal<\"replace\">,\n        Schema.Literal<\"reload\">,\n        Schema.Literal<\"traverse\">\n    ]>;\n    readonly from: Schema.Struct<{\n        readonly id: Schema.String;\n        readonly key: Schema.String;\n        readonly url: Schema.URLFromString;\n        readonly state: Schema.Unknown;\n        readonly sameDocument: Schema.Boolean;\n    }>;\n    readonly delta: Schema.Int;\n    readonly to: Schema.Struct<{\n        readonly url: Schema.URLFromString;\n        readonly state: Schema.Unknown;\n        readonly sameDocument: Schema.Boolean;\n        readonly key: Schema.optional<Schema.String>;\n    }>;\n    readonly info: Schema.Unknown;\n}>;"
        ],
        "typeParameters": [],
        "sourceSpans": [
          {
            "file": "packages/navigation/src/model.ts",
            "start": {
              "line": 199,
              "column": 14
            },
            "end": {
              "line": 205,
              "column": 3
            }
          }
        ],
        "static": false,
        "readonly": false,
        "optional": false
      },
      {
        "family": "type-alias",
        "syntaxKind": "TypeAliasDeclaration",
        "signatures": [
          "export type BeforeNavigationEvent = typeof BeforeNavigationEvent.Type;"
        ],
        "typeParameters": [],
        "sourceSpans": [
          {
            "file": "packages/navigation/src/model.ts",
            "start": {
              "line": 219,
              "column": 1
            },
            "end": {
              "line": 219,
              "column": 71
            }
          }
        ],
        "static": false,
        "readonly": false,
        "optional": false
      }
    ],
    "signatures": [
      "export declare const BeforeNavigationEvent: Schema.Struct<{\n    readonly type: Schema.Union<readonly [\n        Schema.Literal<\"push\">,\n        Schema.Literal<\"replace\">,\n        Schema.Literal<\"reload\">,\n        Schema.Literal<\"traverse\">\n    ]>;\n    readonly from: Schema.Struct<{\n        readonly id: Schema.String;\n        readonly key: Schema.String;\n        readonly url: Schema.URLFromString;\n        readonly state: Schema.Unknown;\n        readonly sameDocument: Schema.Boolean;\n    }>;\n    readonly delta: Schema.Int;\n    readonly to: Schema.Struct<{\n        readonly url: Schema.URLFromString;\n        readonly state: Schema.Unknown;\n        readonly sameDocument: Schema.Boolean;\n        readonly key: Schema.optional<Schema.String>;\n    }>;\n    readonly info: Schema.Unknown;\n}>;",
      "export type BeforeNavigationEvent = typeof BeforeNavigationEvent.Type;"
    ],
    "typeParameters": [],
    "summary": "Describes the pre-commit event presented to navigation guards.",
    "sections": {
      "Why": "Guards need the old and proposed destinations plus traversal delta before a backend mutates\nhistory. This event is deliberately distinct from post-commit {@link NavigationEvent}.",
      "Ownership and lifetime": "The schema acquires no resources. The navigation operation owns each event until its registered\nhandlers settle; handlers must copy data they need later."
    },
    "examples": [
      {
        "language": "ts",
        "code": "import { BeforeNavigationEvent } from \"@typed/navigation/model\"\nimport * as Schema from \"effect/Schema\"\n\nconst isBeforeEvent = Schema.is(BeforeNavigationEvent)"
      }
    ],
    "sourceSpans": [
      {
        "file": "packages/navigation/src/model.ts",
        "start": {
          "line": 199,
          "column": 14
        },
        "end": {
          "line": 205,
          "column": 3
        }
      },
      {
        "file": "packages/navigation/src/model.ts",
        "start": {
          "line": 219,
          "column": 1
        },
        "end": {
          "line": 219,
          "column": 71
        }
      }
    ],
    "since": "1.0.0",
    "category": "Navigation event schemas"
  }
}