@remix-run/router 1.0.3 → 1.0.4-pre.0

package/dist/router.d.ts

@@ -1,4 +1,4 @@
-import type { History, Location, To } from "./history";
+import type { History, Location, Path, To } from "./history";
 import { Action as HistoryAction } from "./history";
 import type { AgnosticDataRouteMatch, AgnosticDataRouteObject, FormEncType, FormMethod, RouteData, AgnosticRouteObject, AgnosticRouteMatch } from "./utils";
 import { DeferredData } from "./utils";
@@ -98,6 +98,15 @@ export interface Router {
      * @param location
      */
     createHref(location: Location | URL): string;
+    /**
+     * @internal
+     * PRIVATE - DO NOT USE
+     *
+     * Utility function to URL encode a destination path according to the internal
+     * history implementation
+     * @param to
+     */
+    encodeLocation(to: To): Path;
     /**
      * @internal
      * PRIVATE - DO NOT USE
@@ -211,6 +220,7 @@ export interface RouterInit {
  * State returned from a server-side query() call
  */
 export interface StaticHandlerContext {
+    basename: Router["basename"];
     location: RouterState["location"];
     matches: RouterState["matches"];
     loaderData: RouterState["loaderData"];
@@ -348,7 +358,9 @@ export declare const IDLE_FETCHER: FetcherStates["Idle"];
  * Create a router and listen to history POP navigations
  */
 export declare function createRouter(init: RouterInit): Router;
-export declare function unstable_createStaticHandler(routes: AgnosticRouteObject[]): StaticHandler;
+export declare function unstable_createStaticHandler(routes: AgnosticRouteObject[], opts?: {
+    basename?: string;
+}): StaticHandler;
 /**
  * Given an existing StaticHandlerContext and an error thrown at render time,
  * provide an updated StaticHandlerContext suitable for a second SSR render