{
  "id": "@typed/navigation#UseBlockNavigationParams",
  "canonicalId": "@typed/navigation#UseBlockNavigationParams",
  "symbol": {
    "id": "@typed/navigation#UseBlockNavigationParams",
    "packageName": "@typed/navigation",
    "moduleName": ".",
    "exportName": "UseBlockNavigationParams",
    "kind": "interface",
    "signatures": [
      "export interface UseBlockNavigationParams<R = never> {\n    readonly shouldBlock?: (event: BeforeNavigationEvent) => Effect.Effect<boolean, RedirectError | CancelNavigation, R>;\n}"
    ],
    "summary": "Configures the optional Effectful predicate used before a transition is blocked.",
    "sections": {
      "Why": "Applications can restrict blocking to dirty forms or selected destinations while keeping that\ndecision in the same typed Effect environment as their state.",
      "Ownership and lifetime": "This object acquires no resources. Its predicate runs in the Scope and captured context of\n{@link useBlockNavigation}; redirects and cancellations remain typed navigation control flow.",
      "Property: shouldBlock": "Decides Effectfully whether a proposed transition should be blocked.",
      "Property: shouldBlock: Why": "Dirty-state checks can use services and still redirect or cancel through typed control flow.",
      "Property: shouldBlock: Ownership and lifetime": "The blocker Scope owns this reactive member; observing it does not extend that Scope."
    },
    "examples": [],
    "relations": [],
    "source": {
      "file": "packages/navigation/src/Blocking.ts",
      "line": 151
    },
    "since": "1.0.0",
    "category": "Blocking policy"
  },
  "exposure": {
    "recordKind": "declaration",
    "id": "@typed/navigation#UseBlockNavigationParams",
    "packageName": "@typed/navigation",
    "packageVersion": "1.0.0-beta.7",
    "moduleName": ".",
    "consumerSpecifier": "@typed/navigation",
    "exportName": "UseBlockNavigationParams",
    "qualifiedName": "UseBlockNavigationParams",
    "declarationKey": "declaration:478ae919076f656cfd0517f8",
    "family": "interface",
    "signatures": [
      "export interface UseBlockNavigationParams<R = never> {\n    readonly shouldBlock?: (event: BeforeNavigationEvent) => Effect.Effect<boolean, RedirectError | CancelNavigation, R>;\n}"
    ],
    "sourceSpans": [
      {
        "file": "packages/navigation/src/Blocking.ts",
        "start": {
          "line": 151,
          "column": 1
        },
        "end": {
          "line": 168,
          "column": 2
        }
      },
      {
        "file": "packages/navigation/src/Blocking.ts",
        "start": {
          "line": 165,
          "column": 3
        },
        "end": {
          "line": 167,
          "column": 68
        }
      }
    ],
    "aliases": [
      "@typed/navigation/Blocking#UseBlockNavigationParams"
    ],
    "isAlias": false,
    "static": false
  },
  "declaration": {
    "declarationKey": "declaration:478ae919076f656cfd0517f8",
    "name": "UseBlockNavigationParams",
    "family": "interface",
    "facets": [
      {
        "family": "interface",
        "syntaxKind": "InterfaceDeclaration",
        "signatures": [
          "export interface UseBlockNavigationParams<R = never> {\n    readonly shouldBlock?: (event: BeforeNavigationEvent) => Effect.Effect<boolean, RedirectError | CancelNavigation, R>;\n}"
        ],
        "typeParameters": [
          "R = never"
        ],
        "sourceSpans": [
          {
            "file": "packages/navigation/src/Blocking.ts",
            "start": {
              "line": 151,
              "column": 1
            },
            "end": {
              "line": 168,
              "column": 2
            }
          }
        ],
        "static": false,
        "readonly": false,
        "optional": false
      },
      {
        "family": "property",
        "syntaxKind": "PropertySignature",
        "signatures": [
          "readonly shouldBlock?: (event: BeforeNavigationEvent) => Effect.Effect<boolean, RedirectError | CancelNavigation, R>;"
        ],
        "typeParameters": [],
        "sourceSpans": [
          {
            "file": "packages/navigation/src/Blocking.ts",
            "start": {
              "line": 165,
              "column": 3
            },
            "end": {
              "line": 167,
              "column": 68
            }
          }
        ],
        "static": false,
        "readonly": true,
        "optional": true
      }
    ],
    "signatures": [
      "export interface UseBlockNavigationParams<R = never> {\n    readonly shouldBlock?: (event: BeforeNavigationEvent) => Effect.Effect<boolean, RedirectError | CancelNavigation, R>;\n}"
    ],
    "typeParameters": [
      "R = never"
    ],
    "summary": "Configures the optional Effectful predicate used before a transition is blocked.",
    "sections": {
      "Why": "Applications can restrict blocking to dirty forms or selected destinations while keeping that\ndecision in the same typed Effect environment as their state.",
      "Ownership and lifetime": "This object acquires no resources. Its predicate runs in the Scope and captured context of\n{@link useBlockNavigation}; redirects and cancellations remain typed navigation control flow.",
      "Property: shouldBlock": "Decides Effectfully whether a proposed transition should be blocked.",
      "Property: shouldBlock: Why": "Dirty-state checks can use services and still redirect or cancel through typed control flow.",
      "Property: shouldBlock: Ownership and lifetime": "The blocker Scope owns this reactive member; observing it does not extend that Scope."
    },
    "examples": [],
    "sourceSpans": [
      {
        "file": "packages/navigation/src/Blocking.ts",
        "start": {
          "line": 151,
          "column": 1
        },
        "end": {
          "line": 168,
          "column": 2
        }
      },
      {
        "file": "packages/navigation/src/Blocking.ts",
        "start": {
          "line": 165,
          "column": 3
        },
        "end": {
          "line": 167,
          "column": 68
        }
      }
    ],
    "since": "1.0.0",
    "category": "Blocking policy"
  }
}