`shouldRevalidate`

类型声明

interface ShouldRevalidateFunction {
  (args: ShouldRevalidateFunctionArgs): boolean;
}

interface ShouldRevalidateFunctionArgs {
  currentUrl: URL;
  currentParams: AgnosticDataRouteMatch["params"];
  nextUrl: URL;
  nextParams: AgnosticDataRouteMatch["params"];
  formMethod?: Submission["formMethod"];
  formAction?: Submission["formAction"];
  formEncType?: Submission["formEncType"];
  text?: Submission["text"];
  formData?: Submission["formData"];
  json?: Submission["json"];
  actionResult?: any;
  defaultShouldRevalidate: boolean;
}

interface ShouldRevalidateFunction {
  (args: ShouldRevalidateFunctionArgs): boolean;
}

interface ShouldRevalidateFunctionArgs {
  currentUrl: URL;
  currentParams: AgnosticDataRouteMatch["params"];
  nextUrl: URL;
  nextParams: AgnosticDataRouteMatch["params"];
  formMethod?: Submission["formMethod"];
  formAction?: Submission["formAction"];
  formEncType?: Submission["formEncType"];
  text?: Submission["text"];
  formData?: Submission["formData"];
  json?: Submission["json"];
  actionResult?: any;
  defaultShouldRevalidate: boolean;
}

通过此功能，您可以选择不对路由的loader进行重新验证，以优化其性能。

IMPORTANT
此功能只有在使用数据路由器时才有效，请参阅"选择路由"。

有几种情况下，数据会被重新验证，从而使用户界面与数据自动保持同步：

从Form调用action后
从<fetcher.Form>调用action后
从useSubmit调用action后
从fetcher.submit调用action后
当通过 useRevalidator触发显式重新验证时
当已渲染路由的URL 参数更改时
当 URL 搜索参数更改时
当导航到与当前 URL 相同的 URL 时

如果在路由上定义了 shouldRevalidate ，那么在调用路由loader获取新数据前，会首先检查该函数。如果函数返回 false ，则不会调用loader，页面上将保留该loader的现有数据。

NOTE
Fetcher 加载也会重新验证，但由于它们加载的是特定 URL，因此不必担心上述 URL 驱动的重新验证情况。Fetcher 载入默认只在提交操作和明确的重新验证请求后重新验证。

jsx

<Route
  path="meals-plans"
  element={<MealPlans />}
  loader={loadMealPlans}
  shouldRevalidate={({ currentUrl }) => {
    // only revalidate if the submission originates from
    // the `/meal-plans/new` route.
    return currentUrl.pathname === "/meal-plans/new";
  }}
>
  <Route
    path="new"
    element={<NewMealPlanForm />}
    // `loadMealPlans` will be revalidated after
    // this action...
    action={createMealPlan}
  />
  <Route
    path=":planId/meal"
    element={<Meal />}
    // ...but not this one because origin the URL
    // is not "/meal-plans/new"
    action={updateMeal}
  />
</Route>

<Route
  path="meals-plans"
  element={<MealPlans />}
  loader={loadMealPlans}
  shouldRevalidate={({ currentUrl }) => {
    // only revalidate if the submission originates from
    // the `/meal-plans/new` route.
    return currentUrl.pathname === "/meal-plans/new";
  }}
>
  <Route
    path="new"
    element={<NewMealPlanForm />}
    // `loadMealPlans` will be revalidated after
    // this action...
    action={createMealPlan}
  />
  <Route
    path=":planId/meal"
    element={<Meal />}
    // ...but not this one because origin the URL
    // is not "/meal-plans/new"
    action={updateMeal}
  />
</Route>

请注意，这仅适用于已加载、当前已呈现并将继续在新 URL 上呈现的数据。新 URL 上的新路由和获取器的数据将始终在初始时获取。

IMPORTANT
使用此 API 有可能导致用户界面与数据不同步，请谨慎使用！

shouldRevalidate ​

​

`shouldRevalidate`