reload

The reload function returns a Response object that instructs the router to revalidate specific queries when returned or thrown from a query or action.

Import

import { reload } from "@solidjs/router";

Type

function reload(init?: {
  revalidate?: string | string[];
  headers?: HeadersInit;
  status?: number;
  statusText?: string;
}): CustomResponse<never>;

Parameters

init

• Type: { revalidate?: string | string[]; headers?: HeadersInit; status?: number; statusText?: string; }
• Required: No

An optional configuration object with the following properties:

revalidate

• Type: string | string[]
• Required: No

A query key or an array of query keys to revalidate.

headers

• Type: HeadersInit
• Required: No

An object containing any headers to be sent with the response.

status

• Type: number
• Required: No

The HTTP status code of the response. Defaults to 200 OK.

statusText

• Type: string
• Required: No

The status text associated with the status code.

Examples

Basic Usage

import { action, reload } from "@solidjs/router";

const savePreferencesAction = action(async () => {
  // ... Saves the user preferences.

  // Only revalidate the "userPreferences" query.
  return reload({ revalidate: ["userPreferences"] });
}, "savePreferences");