/** * Reactive navigation composable. * @module bquery/router * * @since 1.14.0 */ import { type ReadonlySignal } from '../reactive/index'; import type { NavigationResult, Route } from './types'; /** * Return type for {@link useNavigation}. * * @since 1.14.0 */ export type UseNavigationReturn = { /** * Reactive boolean — `true` while any navigation is in progress. * Mirrors the module-level {@link isNavigating} signal. */ isNavigating: ReadonlySignal; /** * Reactive `NavigationResult | null` — the outcome of the most recent * navigation, or `null` if no navigation has occurred yet. * * Tied to `Router.lastNavigation`; falls back to `null` when no router * has been initialized. */ lastNavigation: ReadonlySignal; /** * Reactive route the most recent navigation resolved to, or `null`. */ to: ReadonlySignal; /** * Reactive route the most recent navigation departed from, or `null`. */ from: ReadonlySignal; /** * Reactive error thrown by the most recent navigation, or `null`. */ error: ReadonlySignal; /** * Reactive status string of the most recent navigation, or `null` * if no navigation has occurred yet. */ status: ReadonlySignal; }; export declare const useNavigation: () => UseNavigationReturn; //# sourceMappingURL=use-navigation.d.ts.map