import { Installer } from "../../GlobalContext/types.js";
import { RouterOptions } from "./types.js";

//#region src/router/installRouter/installRouter.d.ts
/**
 * Creates a {@link GlobalContext} installer for a tools `ViewRouter`.
 *
 * The installer exposes the router under the tools router context key and
 * initializes route depth to `-1`, so the first `RouterView` renders depth `0`.
 *
 * @param options - Router instance and optional base path.
 * @returns An installer accepted by `GlobalContext` through its `use` prop.
 *
 * @example
 * ```tsx
 * const installRouterContext = installRouter({ router });
 *
 * <GlobalContext use={installRouterContext}>
 *   <RouterView />
 * </GlobalContext>
 * ```
 */
declare function installRouter(options: RouterOptions): Installer;
//#endregion
export { installRouter };
//# sourceMappingURL=installRouter.d.ts.map