feat!: remove unstable_shouldReload references (#5685)

remix-run · Jul 9, 2023 · a5a78fb · a5a78fb
1 parent 1bdc06a
commit a5a78fb
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 192 deletions.
diff --git a/.changeset/remove-should-reload.md b/.changeset/remove-should-reload.md
@@ -0,0 +1,5 @@
+---
+"@remix-run/react": major
+---
+
+Remove `unstable_shouldReload`, which has been replaced by `shouldRevalidate`
diff --git a/docs/api/conventions.md b/docs/api/conventions.md
@@ -190,21 +190,13 @@ title: Conventions
 
 [Moved →][moved-44]
 
-### unstable_shouldReload
+### shouldRevalidate
 
 [Moved →][moved-45]
 
-#### Never reloading the root
-
-[Moved →][moved-46]
-
-#### Ignoring search params
-
-[Moved →][moved-47]
-
 ## Asset URL Imports
 
-[Moved →][moved-48]
+[Moved →][moved-46]
 
 [moved]: ../file-conventions/remix-config
 [moved-2]: ../file-conventions/remix-config#appdirectory
@@ -250,7 +242,5 @@ title: Conventions
 [moved-42]: ../route/catch-boundary
 [moved-43]: ../route/error-boundary
 [moved-44]: ../route/handle
-[moved-45]: ../route/should-reload
-[moved-46]: ../route/should-reload#never-reloading-the-root
-[moved-47]: ../route/should-reload#ignoring-search-params
-[moved-48]: ../other-api/asset-imports
+[moved-45]: ../route/should-revalidate
+[moved-46]: ../other-api/asset-imports
diff --git a/docs/route/should-reload.md b/docs/route/should-reload.md
diff --git a/packages/remix-react/index.tsx b/packages/remix-react/index.tsx
@@ -77,7 +77,6 @@ export type {
   V2_MetaDescriptor,
   V2_MetaFunction,
   RouteModules as UNSAFE_RouteModules,
-  ShouldReloadFunction,
 } from "./routeModules";
 
 export { ScrollRestoration } from "./scroll-restoration";

diff --git a/packages/remix-react/routeModules.ts b/packages/remix-react/routeModules.ts
@@ -205,26 +205,3 @@ export async function loadRouteModule(
     });
   }
 }
-
-/**
- * @deprecated The `unstable_shouldReload` function has been removed, so this
- * function will never run and route data will be revalidated on every request.
- * Please update the function name to `shouldRevalidate` and use the
- * `ShouldRevalidateFunction` interface.
- */
-export interface ShouldReloadFunction {
-  (args: {
-    url: URL;
-    prevUrl: URL;
-    params: Params;
-    submission?: Submission;
-  }): boolean;
-}
-
-interface Submission {
-  action: string;
-  method: string;
-  formData: FormData;
-  encType: string;
-  key: string;
-}