chore: generate markdown docs from jsdocs

remix-run-bot · remix-run-bot · commit c02cf7aed593 · 2025-07-16T20:49:48.000Z
diff --git a/docs/api/components/Await.md b/docs/api/components/Await.md
@@ -62,7 +62,11 @@ function Book() {
 ## Signature
 
 ```tsx
-function Await<Resolve>({ children, errorElement, resolve, }: AwaitProps<Resolve>)
+function Await<Resolve>({
+  children,
+  errorElement,
+  resolve,
+}: AwaitProps<Resolve>)
 ```
 
 ## Props
diff --git a/docs/api/components/Navigate.md b/docs/api/components/Navigate.md
@@ -35,7 +35,7 @@ It's recommended to avoid using this component in favor of [`useNavigate`](../ho
 ## Signature
 
 ```tsx
-function Navigate({ to, replace, state, relative, }: NavigateProps): null
+function Navigate({ to, replace, state, relative }: NavigateProps): null
 ```
 
 ## Props
diff --git a/docs/api/components/Routes.md b/docs/api/components/Routes.md
@@ -39,7 +39,10 @@ import { Routes, Route } from "react-router";
 ## Signature
 
 ```tsx
-function Routes({ children, location, }: RoutesProps): React.ReactElement | null
+function Routes({
+  children,
+  location,
+}: RoutesProps): React.ReactElement | null
 ```
 
 ## Props
diff --git a/docs/api/components/ScrollRestoration.md b/docs/api/components/ScrollRestoration.md
@@ -48,7 +48,11 @@ This component renders an inline `<script>` to prevent scroll flashing. The `non
 ## Signature
 
 ```tsx
-function ScrollRestoration({ getKey, storageKey, ...props }: ScrollRestorationProps)
+function ScrollRestoration({
+  getKey,
+  storageKey,
+  ...props
+}: ScrollRestorationProps)
 ```
 
 ## Props
diff --git a/docs/api/data-routers/RouterProvider.md b/docs/api/data-routers/RouterProvider.md
@@ -39,7 +39,10 @@ createRoot(document.getElementById("root")).render(
 ## Signature
 
 ```tsx
-function RouterProvider({ router, flushSync: reactDomFlushSyncImpl, }: RouterProviderProps): React.ReactElement
+function RouterProvider({
+  router,
+  flushSync: reactDomFlushSyncImpl,
+}: RouterProviderProps): React.ReactElement
 ```
 
 ## Props
diff --git a/docs/api/data-routers/StaticRouterProvider.md b/docs/api/data-routers/StaticRouterProvider.md
@@ -45,7 +45,12 @@ export async function handleRequest(request: Request) {
 ## Signature
 
 ```tsx
-function StaticRouterProvider({ context, router, hydrate = true, nonce, }: StaticRouterProviderProps)
+function StaticRouterProvider({
+  context,
+  router,
+  hydrate = true,
+  nonce,
+}: StaticRouterProviderProps)
 ```
 
 ## Props
diff --git a/docs/api/data-routers/createBrowserRouter.md b/docs/api/data-routers/createBrowserRouter.md
@@ -28,7 +28,10 @@ and `history.replaceState`.
 ## Signature
 
 ```tsx
-function createBrowserRouter(routes: RouteObject[], opts?: DOMRouterOpts): DataRouter
+function createBrowserRouter(
+  routes: RouteObject[],
+  opts?: DOMRouterOpts,
+): DataRouter
 ```
 
 ## Params
diff --git a/docs/api/data-routers/createHashRouter.md b/docs/api/data-routers/createHashRouter.md
@@ -27,7 +27,10 @@ Create a new data router that manages the application path via the URL hash.
 ## Signature
 
 ```tsx
-function createHashRouter(routes: RouteObject[], opts?: DOMRouterOpts): DataRouter
+function createHashRouter(
+  routes: RouteObject[],
+  opts?: DOMRouterOpts,
+): DataRouter
 ```
 
 ## Params
diff --git a/docs/api/data-routers/createMemoryRouter.md b/docs/api/data-routers/createMemoryRouter.md
@@ -28,7 +28,10 @@ history stack.  Useful for non-browser environments without a DOM API.
 ## Signature
 
 ```tsx
-function createMemoryRouter(routes: RouteObject[], opts?: MemoryRouterOpts): DataRouter
+function createMemoryRouter(
+  routes: RouteObject[],
+  opts?: MemoryRouterOpts,
+): DataRouter
 ```
 
 ## Params
diff --git a/docs/api/data-routers/createStaticHandler.md b/docs/api/data-routers/createStaticHandler.md
@@ -44,7 +44,10 @@ export async function handleRequest(request: Request) {
 ## Signature
 
 ```tsx
-function createStaticHandler(routes: RouteObject[], opts?: CreateStaticHandlerOptions)
+function createStaticHandler(
+  routes: RouteObject[],
+  opts?: CreateStaticHandlerOptions,
+)
 ```
 
 ## Params
diff --git a/docs/api/data-routers/createStaticRouter.md b/docs/api/data-routers/createStaticRouter.md
@@ -44,9 +44,13 @@ export async function handleRequest(request: Request) {
 ## Signature
 
 ```tsx
-function createStaticRouter(routes: RouteObject[], context: StaticHandlerContext, opts: {
+function createStaticRouter(
+  routes: RouteObject[],
+  context: StaticHandlerContext,
+  opts: {
     future?: Partial<FutureConfig>;
-} = {}): DataRouter
+  } = ,
+): DataRouter {}
 ```
 
 ## Params
diff --git a/docs/api/declarative-routers/BrowserRouter.md b/docs/api/declarative-routers/BrowserRouter.md
@@ -27,7 +27,7 @@ A declarative `<Router>` using the browser history API for client side routing.
 ## Signature
 
 ```tsx
-function BrowserRouter({ basename, children, window, }: BrowserRouterProps)
+function BrowserRouter({ basename, children, window }: BrowserRouterProps)
 ```
 
 ## Props
diff --git a/docs/api/declarative-routers/HistoryRouter.md b/docs/api/declarative-routers/HistoryRouter.md
@@ -38,7 +38,7 @@ the same version of the history library that React Router uses internally.
 ## Signature
 
 ```tsx
-function HistoryRouter({ basename, children, history, }: HistoryRouterProps)
+function HistoryRouter({ basename, children, history }: HistoryRouterProps)
 ```
 
 ## Props
diff --git a/docs/api/declarative-routers/MemoryRouter.md b/docs/api/declarative-routers/MemoryRouter.md
@@ -27,7 +27,12 @@ A declarative `<Router>` that stores all entries in memory.
 ## Signature
 
 ```tsx
-function MemoryRouter({ basename, children, initialEntries, initialIndex, }: MemoryRouterProps): React.ReactElement
+function MemoryRouter({
+  basename,
+  children,
+  initialEntries,
+  initialIndex,
+}: MemoryRouterProps): React.ReactElement
 ```
 
 ## Props
diff --git a/docs/api/declarative-routers/Router.md b/docs/api/declarative-routers/Router.md
@@ -31,7 +31,14 @@ in web browsers or a `<StaticRouter>` for server rendering.
 ## Signature
 
 ```tsx
-function Router({ basename: basenameProp = "/", children = null, location: locationProp, navigationType = NavigationType.Pop, navigator, static: staticProp = false, }: RouterProps): React.ReactElement | null
+function Router({
+  basename: basenameProp = "/",
+  children = null,
+  location: locationProp,
+  navigationType = NavigationType.Pop,
+  navigator,
+  static: staticProp = false,
+}: RouterProps): React.ReactElement | null
 ```
 
 ## Props
diff --git a/docs/api/declarative-routers/StaticRouter.md b/docs/api/declarative-routers/StaticRouter.md
@@ -28,7 +28,11 @@ on the server where there is no stateful UI.
 ## Signature
 
 ```tsx
-function StaticRouter({ basename, children, location: locationProp = "/", }: StaticRouterProps)
+function StaticRouter({
+  basename,
+  children,
+  location: locationProp = "/",
+}: StaticRouterProps)
 ```
 
 ## Props
diff --git a/docs/api/framework-routers/ServerRouter.md b/docs/api/framework-routers/ServerRouter.md
@@ -29,7 +29,11 @@ See [`entry.server.tsx`](../api/framework-conventions/entry.server.tsx).
 ## Signature
 
 ```tsx
-function ServerRouter({ context, url, nonce, }: ServerRouterProps): ReactElement
+function ServerRouter({
+  context,
+  url,
+  nonce,
+}: ServerRouterProps): ReactElement
 ```
 
 ## Props
diff --git a/docs/api/hooks/useBeforeUnload.md b/docs/api/hooks/useBeforeUnload.md
@@ -27,9 +27,12 @@ Set up a callback to be fired on [Window's `beforeunload` event](https://develop
 ## Signature
 
 ```tsx
-function useBeforeUnload(callback: (event: BeforeUnloadEvent) => any, options?: {
+function useBeforeUnload(
+  callback: (event: BeforeUnloadEvent) => any,
+  options?: {
     capture?: boolean;
-}): void
+  },
+): void
 ```
 
 ## Params
diff --git a/docs/api/hooks/useFetcher.md b/docs/api/hooks/useFetcher.md
@@ -57,9 +57,11 @@ function SomeComponent() {
 ## Signature
 
 ```tsx
-function useFetcher<T = any>({ key, }: {
-    key?: string;
-} = {}): FetcherWithComponents<SerializeFrom<T>>
+function useFetcher<T = any>({
+  key,
+}: {
+  key?: string;
+} = ): FetcherWithComponents<SerializeFrom<T>> {}
 ```
 
 ## Params
diff --git a/docs/api/hooks/useFetchers.md b/docs/api/hooks/useFetchers.md
@@ -41,7 +41,7 @@ function SomeComponent() {
 
 ```tsx
 function useFetchers(): (Fetcher & {
-    key: string;
+  key: string;
 })[]
 ```
 
diff --git a/docs/api/hooks/useFormAction.md b/docs/api/hooks/useFormAction.md
@@ -43,9 +43,14 @@ function SomeComponent() {
 ## Signature
 
 ```tsx
-function useFormAction(action?: string, { relative }: {
+function useFormAction(
+  action?: string,
+  {
+    relative,
+  }: {
     relative?: RelativeRoutingType;
-} = {}): string
+  } = ,
+): string {}
 ```
 
 ## Params
diff --git a/docs/api/hooks/useHref.md b/docs/api/hooks/useHref.md
@@ -36,9 +36,14 @@ function SomeComponent() {
 ## Signature
 
 ```tsx
-function useHref(to: To, { relative }: {
+function useHref(
+  to: To,
+  {
+    relative,
+  }: {
     relative?: RelativeRoutingType;
-} = {}): string
+  } = ,
+): string {}
 ```
 
 ## Params
diff --git a/docs/api/hooks/useLinkClickHandler.md b/docs/api/hooks/useLinkClickHandler.md
@@ -29,14 +29,24 @@ use in our exported `<Link>`.
 ## Signature
 
 ```tsx
-function useLinkClickHandler<E extends Element = HTMLAnchorElement>(to: To, { target, replace: replaceProp, state, preventScrollReset, relative, viewTransition, }: {
+function useLinkClickHandler<E extends Element = HTMLAnchorElement>(
+  to: To,
+  {
+    target,
+    replace: replaceProp,
+    state,
+    preventScrollReset,
+    relative,
+    viewTransition,
+  }: {
     target?: React.HTMLAttributeAnchorTarget;
     replace?: boolean;
     state?: any;
     preventScrollReset?: boolean;
     relative?: RelativeRoutingType;
     viewTransition?: boolean;
-} = {}): (event: React.MouseEvent<E, MouseEvent>) => void
+  } = ,
+): (event: React.MouseEvent<E, MouseEvent>) => void {}
 ```
 
 ## Params
diff --git a/docs/api/hooks/useMatch.md b/docs/api/hooks/useMatch.md
@@ -29,7 +29,9 @@ This is useful for components that need to know "active" state, e.g.
 ## Signature
 
 ```tsx
-function useMatch<ParamKey extends ParamParseKey<Path>, Path extends string>(pattern: PathPattern<Path> | Path): PathMatch<ParamKey> | null
+function useMatch<ParamKey extends ParamParseKey<Path>, Path extends string>(
+  pattern: PathPattern<Path> | Path,
+): PathMatch<ParamKey> | null
 ```
 
 ## Params
diff --git a/docs/api/hooks/useParams.md b/docs/api/hooks/useParams.md
@@ -38,11 +38,11 @@ function SomeComponent() {
 ## Signature
 
 ```tsx
-function useParams<ParamsOrKey extends string | Record<string, string | undefined> = string>(): Readonly<[
-    ParamsOrKey
-] extends [
-    string
-] ? Params<ParamsOrKey> : Partial<ParamsOrKey>>
+function useParams<
+  ParamsOrKey extends string | Record<string, string | undefined> = string,
+>(): Readonly<
+  [ParamsOrKey] extends [string] ? Params<ParamsOrKey> : Partial<ParamsOrKey>
+>
 ```
 
 ## Returns
diff --git a/docs/api/hooks/usePrompt.md b/docs/api/hooks/usePrompt.md
@@ -65,9 +65,12 @@ function ImportantForm() {
 ## Signature
 
 ```tsx
-function usePrompt({ when, message, }: {
-    when: boolean | BlockerFunction;
-    message: string;
+function usePrompt({
+  when,
+  message,
+}: {
+  when: boolean | BlockerFunction;
+  message: string;
 }): void
 ```
 
diff --git a/docs/api/hooks/useResolvedPath.md b/docs/api/hooks/useResolvedPath.md
@@ -39,9 +39,14 @@ function SomeComponent() {
 ## Signature
 
 ```tsx
-function useResolvedPath(to: To, { relative }: {
+function useResolvedPath(
+  to: To,
+  {
+    relative,
+  }: {
     relative?: RelativeRoutingType;
-} = {}): Path
+  } = ,
+): Path {}
 ```
 
 ## Params
diff --git a/docs/api/hooks/useRevalidator.md b/docs/api/hooks/useRevalidator.md
@@ -53,8 +53,8 @@ function WindowFocusRevalidator() {
 
 ```tsx
 function useRevalidator(): {
-    revalidate: () => Promise<void>;
-    state: DataRouter["state"]["revalidation"];
+  revalidate: () => Promise<void>;
+  state: DataRouter["state"]["revalidation"];
 }
 ```
 
diff --git a/docs/api/hooks/useRouteLoaderData.md b/docs/api/hooks/useRouteLoaderData.md
@@ -48,7 +48,9 @@ useRouteLoaderData("app");
 ## Signature
 
 ```tsx
-function useRouteLoaderData<T = any>(routeId: string): SerializeFrom<T> | undefined
+function useRouteLoaderData<T = any>(
+  routeId: string,
+): SerializeFrom<T> | undefined
 ```
 
 ## Params
diff --git a/docs/api/hooks/useRoutes.md b/docs/api/hooks/useRoutes.md
diff --git a/docs/api/hooks/useSearchParams.md b/docs/api/hooks/useSearchParams.md
diff --git a/docs/api/hooks/useViewTransitionState.md b/docs/api/hooks/useViewTransitionState.md
diff --git a/docs/api/utils/renderMatches.md b/docs/api/utils/renderMatches.md
