{
  "id": "@typed/navigation#useBlockNavigation",
  "canonicalId": "@typed/navigation#useBlockNavigation",
  "symbol": {
    "id": "@typed/navigation#useBlockNavigation",
    "packageName": "@typed/navigation",
    "moduleName": ".",
    "exportName": "useBlockNavigation",
    "kind": "constant",
    "signatures": [
      "export declare const useBlockNavigation: <R = never>(params?: UseBlockNavigationParams<R>) => Effect.Effect<BlockNavigation, never, Navigation | R | Scope.Scope>;"
    ],
    "summary": "Registers a scoped navigation blocker and returns renderer-independent blocking state.",
    "sections": {
      "Why": "Unsaved-work flows need to pause navigation without replacing the provider or forcing state into a\nUI component. At most one transition is outstanding; later attempts are not independently queued.",
      "Ownership and lifetime": "The required Scope owns the before-navigation registration, RefSubject, and deferred settlement.\nScope closure cancels an outstanding transition and finalizes the registration. Consumers must\nobserve and settle the returned state inside that owning Scope."
    },
    "examples": [
      {
        "language": "text",
        "code": "```ts\nimport { useBlockNavigation } from \"@typed/navigation/Blocking\"\nimport * as Effect from \"effect/Effect\"\n\nconst blocker = useBlockNavigation({ shouldBlock: () => Effect.succeed(true) })\n```\n\nScope behavior follows Effect v4 resource management:\nhttps://effect.website/docs/resource-management/scope/."
      }
    ],
    "relations": [],
    "source": {
      "file": "packages/navigation/src/Blocking.ts",
      "line": 197
    },
    "since": "1.0.0",
    "category": "Blocking policy"
  },
  "exposure": {
    "recordKind": "declaration",
    "id": "@typed/navigation#useBlockNavigation",
    "packageName": "@typed/navigation",
    "packageVersion": "1.0.0-beta.7",
    "moduleName": ".",
    "consumerSpecifier": "@typed/navigation",
    "exportName": "useBlockNavigation",
    "qualifiedName": "useBlockNavigation",
    "declarationKey": "declaration:fa82763d3d65e3e52c22d7ee",
    "family": "variable",
    "signatures": [
      "export declare const useBlockNavigation: <R = never>(params?: UseBlockNavigationParams<R>) => Effect.Effect<BlockNavigation, never, Navigation | R | Scope.Scope>;"
    ],
    "sourceSpans": [
      {
        "file": "packages/navigation/src/Blocking.ts",
        "start": {
          "line": 197,
          "column": 14
        },
        "end": {
          "line": 248,
          "column": 5
        }
      }
    ],
    "aliases": [
      "@typed/navigation/Blocking#useBlockNavigation"
    ],
    "isAlias": false,
    "static": false
  },
  "declaration": {
    "declarationKey": "declaration:fa82763d3d65e3e52c22d7ee",
    "name": "useBlockNavigation",
    "family": "variable",
    "facets": [
      {
        "family": "variable",
        "syntaxKind": "VariableDeclaration",
        "signatures": [
          "export declare const useBlockNavigation: <R = never>(params?: UseBlockNavigationParams<R>) => Effect.Effect<BlockNavigation, never, Navigation | R | Scope.Scope>;"
        ],
        "typeParameters": [],
        "sourceSpans": [
          {
            "file": "packages/navigation/src/Blocking.ts",
            "start": {
              "line": 197,
              "column": 14
            },
            "end": {
              "line": 248,
              "column": 5
            }
          }
        ],
        "static": false,
        "readonly": false,
        "optional": false
      }
    ],
    "signatures": [
      "export declare const useBlockNavigation: <R = never>(params?: UseBlockNavigationParams<R>) => Effect.Effect<BlockNavigation, never, Navigation | R | Scope.Scope>;"
    ],
    "typeParameters": [],
    "summary": "Registers a scoped navigation blocker and returns renderer-independent blocking state.",
    "sections": {
      "Why": "Unsaved-work flows need to pause navigation without replacing the provider or forcing state into a\nUI component. At most one transition is outstanding; later attempts are not independently queued.",
      "Ownership and lifetime": "The required Scope owns the before-navigation registration, RefSubject, and deferred settlement.\nScope closure cancels an outstanding transition and finalizes the registration. Consumers must\nobserve and settle the returned state inside that owning Scope."
    },
    "examples": [
      {
        "language": "text",
        "code": "```ts\nimport { useBlockNavigation } from \"@typed/navigation/Blocking\"\nimport * as Effect from \"effect/Effect\"\n\nconst blocker = useBlockNavigation({ shouldBlock: () => Effect.succeed(true) })\n```\n\nScope behavior follows Effect v4 resource management:\nhttps://effect.website/docs/resource-management/scope/."
      }
    ],
    "sourceSpans": [
      {
        "file": "packages/navigation/src/Blocking.ts",
        "start": {
          "line": 197,
          "column": 14
        },
        "end": {
          "line": 248,
          "column": 5
        }
      }
    ],
    "since": "1.0.0",
    "category": "Blocking policy"
  }
}