{
  "id": "@typed/svelte#useNavigation",
  "canonicalId": "@typed/svelte#useNavigation",
  "symbol": {
    "id": "@typed/svelte#useNavigation",
    "packageName": "@typed/svelte",
    "moduleName": ".",
    "exportName": "useNavigation",
    "kind": "function",
    "signatures": [
      "export declare function useNavigation<ER = never>(options?: SourceOptions<Destination, never, Navigation, ER>): {\n    location: import(\"./AsyncData.js\").AsyncState<{\n        readonly id: string;\n        readonly key: string;\n        readonly url: URL;\n        readonly state: unknown;\n        readonly sameDocument: boolean;\n    }, ER>;\n    entries: import(\"./AsyncData.js\").AsyncState<readonly {\n        readonly id: string;\n        readonly key: string;\n        readonly url: URL;\n        readonly state: unknown;\n        readonly sameDocument: boolean;\n    }[], ER>;\n    transition: import(\"./AsyncData.js\").AsyncState<Option.Option<{\n        readonly type: \"push\" | \"replace\" | \"reload\" | \"traverse\";\n        readonly from: {\n            readonly id: string;\n            readonly key: string;\n            readonly url: URL;\n            readonly state: unknown;\n            readonly sameDocument: boolean;\n        };\n        readonly to: {\n            readonly url: URL;\n            readonly state: unknown;\n            readonly sameDocument: boolean;\n            readonly key?: string | undefined;\n        };\n        readonly info?: unknown;\n    }>, ER>;\n    canGoBack: import(\"./AsyncData.js\").AsyncState<boolean, ER>;\n    canGoForward: import(\"./AsyncData.js\").AsyncState<boolean, ER>;\n    navigate: (url: string | URL, options?: import(\"@typed/navigation/Navigation\").NavigationNavigateOptions | undefined) => Promise<{\n        readonly id: string;\n        readonly key: string;\n        readonly url: URL;\n        readonly state: unknown;\n        readonly sameDocument: boolean;\n    }>;\n    back: (options?: import(\"@typed/navigation/Navigation\").NavigationInfoOptions | undefined) => Promise<{\n        readonly id: string;\n        readonly key: string;\n        readonly url: URL;\n        readonly state: unknown;\n        readonly sameDocument: boolean;\n    }>;\n    forward: (options?: import(\"@typed/navigation/Navigation\").NavigationInfoOptions | undefined) => Promise<{\n        readonly id: string;\n        readonly key: string;\n        readonly url: URL;\n        readonly state: unknown;\n        readonly sameDocument: boolean;\n    }>;\n};"
    ],
    "summary": "Native state plus promise commands using the closest Navigation service.\nCommands use the latest provider after runtime replacement.",
    "sections": {},
    "examples": [],
    "relations": [],
    "source": {
      "file": "packages/svelte/src/Router.ts",
      "line": 48
    },
    "category": "function"
  },
  "exposure": {
    "recordKind": "declaration",
    "id": "@typed/svelte#useNavigation",
    "packageName": "@typed/svelte",
    "packageVersion": "1.0.0-beta.13",
    "moduleName": ".",
    "consumerSpecifier": "@typed/svelte",
    "exportName": "useNavigation",
    "qualifiedName": "useNavigation",
    "declarationKey": "declaration:fe7fff275baf4978216a9e1f",
    "family": "function",
    "signatures": [
      "export declare function useNavigation<ER = never>(options?: SourceOptions<Destination, never, Navigation, ER>): {\n    location: import(\"./AsyncData.js\").AsyncState<{\n        readonly id: string;\n        readonly key: string;\n        readonly url: URL;\n        readonly state: unknown;\n        readonly sameDocument: boolean;\n    }, ER>;\n    entries: import(\"./AsyncData.js\").AsyncState<readonly {\n        readonly id: string;\n        readonly key: string;\n        readonly url: URL;\n        readonly state: unknown;\n        readonly sameDocument: boolean;\n    }[], ER>;\n    transition: import(\"./AsyncData.js\").AsyncState<Option.Option<{\n        readonly type: \"push\" | \"replace\" | \"reload\" | \"traverse\";\n        readonly from: {\n            readonly id: string;\n            readonly key: string;\n            readonly url: URL;\n            readonly state: unknown;\n            readonly sameDocument: boolean;\n        };\n        readonly to: {\n            readonly url: URL;\n            readonly state: unknown;\n            readonly sameDocument: boolean;\n            readonly key?: string | undefined;\n        };\n        readonly info?: unknown;\n    }>, ER>;\n    canGoBack: import(\"./AsyncData.js\").AsyncState<boolean, ER>;\n    canGoForward: import(\"./AsyncData.js\").AsyncState<boolean, ER>;\n    navigate: (url: string | URL, options?: import(\"@typed/navigation/Navigation\").NavigationNavigateOptions | undefined) => Promise<{\n        readonly id: string;\n        readonly key: string;\n        readonly url: URL;\n        readonly state: unknown;\n        readonly sameDocument: boolean;\n    }>;\n    back: (options?: import(\"@typed/navigation/Navigation\").NavigationInfoOptions | undefined) => Promise<{\n        readonly id: string;\n        readonly key: string;\n        readonly url: URL;\n        readonly state: unknown;\n        readonly sameDocument: boolean;\n    }>;\n    forward: (options?: import(\"@typed/navigation/Navigation\").NavigationInfoOptions | undefined) => Promise<{\n        readonly id: string;\n        readonly key: string;\n        readonly url: URL;\n        readonly state: unknown;\n        readonly sameDocument: boolean;\n    }>;\n};"
    ],
    "sourceSpans": [
      {
        "file": "packages/svelte/src/Router.ts",
        "start": {
          "line": 48,
          "column": 1
        },
        "end": {
          "line": 73,
          "column": 2
        }
      }
    ],
    "aliases": [
      "@typed/svelte/Router#useNavigation"
    ],
    "isAlias": false,
    "static": false
  },
  "declaration": {
    "declarationKey": "declaration:fe7fff275baf4978216a9e1f",
    "name": "useNavigation",
    "family": "function",
    "facets": [
      {
        "family": "function",
        "syntaxKind": "FunctionDeclaration",
        "signatures": [
          "export declare function useNavigation<ER = never>(options?: SourceOptions<Destination, never, Navigation, ER>): {\n    location: import(\"./AsyncData.js\").AsyncState<{\n        readonly id: string;\n        readonly key: string;\n        readonly url: URL;\n        readonly state: unknown;\n        readonly sameDocument: boolean;\n    }, ER>;\n    entries: import(\"./AsyncData.js\").AsyncState<readonly {\n        readonly id: string;\n        readonly key: string;\n        readonly url: URL;\n        readonly state: unknown;\n        readonly sameDocument: boolean;\n    }[], ER>;\n    transition: import(\"./AsyncData.js\").AsyncState<Option.Option<{\n        readonly type: \"push\" | \"replace\" | \"reload\" | \"traverse\";\n        readonly from: {\n            readonly id: string;\n            readonly key: string;\n            readonly url: URL;\n            readonly state: unknown;\n            readonly sameDocument: boolean;\n        };\n        readonly to: {\n            readonly url: URL;\n            readonly state: unknown;\n            readonly sameDocument: boolean;\n            readonly key?: string | undefined;\n        };\n        readonly info?: unknown;\n    }>, ER>;\n    canGoBack: import(\"./AsyncData.js\").AsyncState<boolean, ER>;\n    canGoForward: import(\"./AsyncData.js\").AsyncState<boolean, ER>;\n    navigate: (url: string | URL, options?: import(\"@typed/navigation/Navigation\").NavigationNavigateOptions | undefined) => Promise<{\n        readonly id: string;\n        readonly key: string;\n        readonly url: URL;\n        readonly state: unknown;\n        readonly sameDocument: boolean;\n    }>;\n    back: (options?: import(\"@typed/navigation/Navigation\").NavigationInfoOptions | undefined) => Promise<{\n        readonly id: string;\n        readonly key: string;\n        readonly url: URL;\n        readonly state: unknown;\n        readonly sameDocument: boolean;\n    }>;\n    forward: (options?: import(\"@typed/navigation/Navigation\").NavigationInfoOptions | undefined) => Promise<{\n        readonly id: string;\n        readonly key: string;\n        readonly url: URL;\n        readonly state: unknown;\n        readonly sameDocument: boolean;\n    }>;\n};"
        ],
        "typeParameters": [
          "ER = never"
        ],
        "sourceSpans": [
          {
            "file": "packages/svelte/src/Router.ts",
            "start": {
              "line": 48,
              "column": 1
            },
            "end": {
              "line": 73,
              "column": 2
            }
          }
        ],
        "static": false,
        "readonly": false,
        "optional": false
      }
    ],
    "signatures": [
      "export declare function useNavigation<ER = never>(options?: SourceOptions<Destination, never, Navigation, ER>): {\n    location: import(\"./AsyncData.js\").AsyncState<{\n        readonly id: string;\n        readonly key: string;\n        readonly url: URL;\n        readonly state: unknown;\n        readonly sameDocument: boolean;\n    }, ER>;\n    entries: import(\"./AsyncData.js\").AsyncState<readonly {\n        readonly id: string;\n        readonly key: string;\n        readonly url: URL;\n        readonly state: unknown;\n        readonly sameDocument: boolean;\n    }[], ER>;\n    transition: import(\"./AsyncData.js\").AsyncState<Option.Option<{\n        readonly type: \"push\" | \"replace\" | \"reload\" | \"traverse\";\n        readonly from: {\n            readonly id: string;\n            readonly key: string;\n            readonly url: URL;\n            readonly state: unknown;\n            readonly sameDocument: boolean;\n        };\n        readonly to: {\n            readonly url: URL;\n            readonly state: unknown;\n            readonly sameDocument: boolean;\n            readonly key?: string | undefined;\n        };\n        readonly info?: unknown;\n    }>, ER>;\n    canGoBack: import(\"./AsyncData.js\").AsyncState<boolean, ER>;\n    canGoForward: import(\"./AsyncData.js\").AsyncState<boolean, ER>;\n    navigate: (url: string | URL, options?: import(\"@typed/navigation/Navigation\").NavigationNavigateOptions | undefined) => Promise<{\n        readonly id: string;\n        readonly key: string;\n        readonly url: URL;\n        readonly state: unknown;\n        readonly sameDocument: boolean;\n    }>;\n    back: (options?: import(\"@typed/navigation/Navigation\").NavigationInfoOptions | undefined) => Promise<{\n        readonly id: string;\n        readonly key: string;\n        readonly url: URL;\n        readonly state: unknown;\n        readonly sameDocument: boolean;\n    }>;\n    forward: (options?: import(\"@typed/navigation/Navigation\").NavigationInfoOptions | undefined) => Promise<{\n        readonly id: string;\n        readonly key: string;\n        readonly url: URL;\n        readonly state: unknown;\n        readonly sameDocument: boolean;\n    }>;\n};"
    ],
    "typeParameters": [
      "ER = never"
    ],
    "summary": "Native state plus promise commands using the closest Navigation service.\nCommands use the latest provider after runtime replacement.",
    "sections": {},
    "examples": [],
    "sourceSpans": [
      {
        "file": "packages/svelte/src/Router.ts",
        "start": {
          "line": 48,
          "column": 1
        },
        "end": {
          "line": 73,
          "column": 2
        }
      }
    ]
  }
}