Update more jsdocs for utils.ts

Author: brophdawg11

.eslintrc

@@ -35,6 +35,7 @@
         "packages/react-router/lib/dom/ssr/server.tsx",
         "packages/react-router/lib/dom-export/hydrated-router.tsx",
         "packages/react-router/lib/dom/server.tsx",
+        "packages/react-router/lib/router/utils.ts",
         "packages/react-router/lib/rsc/browser.tsx",
         "packages/react-router/lib/rsc/server.rsc.ts",
         "packages/react-router/lib/rsc/server.ssr.tsx",

packages/react-router/lib/components.tsx

@@ -162,7 +162,7 @@ export interface MemoryRouterOpts {
    */
   initialEntries?: InitialEntry[];
   /**
-   * Index of {@link initialEntries} the application should initialize to
+   * Index of `initialEntries` the application should initialize to
    */
   initialIndex?: number;
   /**
@@ -572,7 +572,7 @@ export interface MemoryRouterProps {
    */
   initialEntries?: InitialEntry[];
   /**
-   * Index of {@link initialEntries} the application should initialize to
+   * Index of `initialEntries` the application should initialize to
    */
   initialIndex?: number;
 }
@@ -649,7 +649,7 @@ export interface NavigateProps {
    */
   state?: any;
   /**
-   * How to interpret relative routing in the {@link to} prop.
+   * How to interpret relative routing in the `to` prop.
    * See {@link RelativeRoutingType}.
    */
   relative?: RelativeRoutingType;
@@ -814,32 +814,32 @@ export interface PathRouteProps {
   children?: React.ReactNode;
   /**
    * The React element to render when this Route matches.
-   * Mutually exclusive with {@link Component}.
+   * Mutually exclusive with `Component`.
    */
   element?: React.ReactNode | null;
   /**
    * The React element to render while this router is loading data.
-   * Mutually exclusive with {@link HydrateFallback}.
+   * Mutually exclusive with `HydrateFallback`.
    */
   hydrateFallbackElement?: React.ReactNode | null;
   /**
    * The React element to render at this route if an error occurs.
-   * Mutually exclusive with {@link ErrorBoundary}.
+   * Mutually exclusive with `ErrorBoundary`.
    */
   errorElement?: React.ReactNode | null;
   /**
    * The React Component to render when this route matches.
-   * Mutually exclusive with {@link element}.
+   * Mutually exclusive with `element`.
    */
   Component?: React.ComponentType | null;
   /**
    * The React Component to render while this router is loading data.
-   * Mutually exclusive with {@link hydrateFallbackElement}.
+   * Mutually exclusive with `hydrateFallbackElement`.
    */
   HydrateFallback?: React.ComponentType | null;
   /**
    * The React Component to render at this route if an error occurs.
-   * Mutually exclusive with {@link errorElement}.
+   * Mutually exclusive with `errorElement`.
    */
   ErrorBoundary?: React.ComponentType | null;
 }
@@ -902,32 +902,32 @@ export interface IndexRouteProps {
   children?: undefined;
   /**
    * The React element to render when this Route matches.
-   * Mutually exclusive with {@link Component}.
+   * Mutually exclusive with `Component`.
    */
   element?: React.ReactNode | null;
   /**
    * The React element to render while this router is loading data.
-   * Mutually exclusive with {@link HydrateFallback}.
+   * Mutually exclusive with `HydrateFallback`.
    */
   hydrateFallbackElement?: React.ReactNode | null;
   /**
    * The React element to render at this route if an error occurs.
-   * Mutually exclusive with {@link ErrorBoundary}.
+   * Mutually exclusive with `ErrorBoundary`.
    */
   errorElement?: React.ReactNode | null;
   /**
    * The React Component to render when this route matches.
-   * Mutually exclusive with {@link element}.
+   * Mutually exclusive with `element`.
    */
   Component?: React.ComponentType | null;
   /**
    * The React Component to render while this router is loading data.
-   * Mutually exclusive with {@link hydrateFallbackElement}.
+   * Mutually exclusive with `hydrateFallbackElement`.
    */
   HydrateFallback?: React.ComponentType | null;
   /**
    * The React Component to render at this route if an error occurs.
-   * Mutually exclusive with {@link errorElement}.
+   * Mutually exclusive with `errorElement`.
    */
   ErrorBoundary?: React.ComponentType | null;
 }

packages/react-router/lib/dom-export/hydrated-router.tsx

@@ -210,7 +210,7 @@ function createHydratedRouter({
 }
 
 /**
- * Props for the {@link HydratedRouter} component.
+ * Props for the {@link dom.HydratedRouter} component.
  *
  * @category Types
  */

packages/react-router/lib/dom/lib.tsx

@@ -171,16 +171,15 @@ export interface DOMRouterOpts {
    * [`clientLoader`](../../start/framework/route-module#clientLoader)), you may
    * want to include `loaderData` for only some routes that were loaded/rendered
    * on the server. This allows you to hydrate _some_ of the routes (such as the
-   * app layout/shell) while showing a {@link PathRouteProps.HydrateFallback | `HydrateFallback`}
+   * app layout/shell) while showing a `HydrateFallback`
    * component and running the [`loader`](../../start/data/route-object#loader)s
    * for other routes during hydration.
    *
    * A route [`loader`](../../start/data/route-object#loader) will run during
    * hydration in two scenarios:
    *
    *  1. No hydration data is provided
-   *     In these cases the {@link PathRouteProps.HydrateFallback | `HydrateFallback`}
-   *     component will render on initial hydration
+   *     In these cases the `HydrateFallback` component will render on initial hydration
    *  2. The `loader.hydrate` property is set to `true`
    *     This allows you to run the [`loader`](../../start/data/route-object#loader)
    *     even if you did not render a fallback on initial hydration (i.e., to
@@ -242,9 +241,9 @@ export interface DOMRouterOpts {
    *
    * The `dataStrategy` function should return a key/value-object of
    * `routeId` -> {@link DataStrategyResult} and should include entries for any
-   * routes where a handler was executed. A {@link DataStrategyResult} indicates
-   * if the handler was successful or not based on the {@link DataStrategyResult.type}
-   * field. If the returned {@link DataStrategyResult.result} is a [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response),
+   * routes where a handler was executed. A `DataStrategyResult` indicates
+   * if the handler was successful or not based on the `DataStrategyResult.type`
+   * field. If the returned `DataStrategyResult.result` is a [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response),
    * React Router will unwrap it for you (via [`res.json`](https://developer.mozilla.org/en-US/docs/Web/API/Response/json)
    * or [`res.text`](https://developer.mozilla.org/en-US/docs/Web/API/Response/text)).
    * If you need to do custom decoding of a [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)
@@ -438,7 +437,7 @@ export interface DOMRouterOpts {
    *
    * `patchRoutesOnNavigation` will be called anytime React Router is unable to
    * match a `path`. The arguments include the `path`, any partial
-   * {@link RouteMatch | `matches`}, and a `patch` function you can call to patch
+   * `matches`, and a `patch` function you can call to patch
    * new routes into the tree at a specific location. This method is executed
    * during the `loading` portion of the navigation for `GET` requests and during
    * the `submitting` portion of the navigation for non-`GET` requests.
@@ -541,7 +540,7 @@ export interface DOMRouterOpts {
    *   **Co-locating route discovery with route definition**
    *
    *   If you don't wish to perform your own pseudo-matching, you can leverage
-   *   the partial {@link RouteMatch | `matches`} array and the [`handle`](../../start/data/route-object#handle)
+   *   the partial `matches` array and the [`handle`](../../start/data/route-object#handle)
    *   field on a route to keep the children definitions co-located:
    *
    *   ```tsx