Skip to content

Precognition docs #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pascalbaljet wants to merge 5 commits into
base: main
Choose a base branch
from
+757 −0
Open

Precognition docs #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
528e9e1
wip
pascalbaljet Nov 26, 2025
e339925
Update the-protocol.mdx
pascalbaljet Nov 28, 2025
f40340e
Update forms.mdx
pascalbaljet Nov 28, 2025
e8a9320
Update forms.mdx
pascalbaljet Nov 28, 2025
9345282
Update forms.mdx
taylorotwell Dec 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions v2/core-concepts/the-protocol.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,16 @@ The following headers are automatically sent by Inertia when making requests. Yo
Indicates whether the requested data should be appended or prepended when using [Infinite scroll](/v2/data-props/infinite-scroll).
</ParamField>

The following headers are used for [Precognition](/v2/the-basics/forms#precognition) validation requests.

<ParamField header="Precognition" type="boolean">
Set to `true` to indicate this is a Precognition validation request.
</ParamField>

<ParamField header="Precognition-Validate-Only" type="string">
Comma-separated list of field names to validate.
</ParamField>

## Response Headers

The following headers should be sent by your server-side adapter in Inertia responses. If you're using an official server-side adapter, these are handled automatically.
Expand All @@ -159,6 +169,20 @@ The following headers should be sent by your server-side adapter in Inertia resp
Set to `X-Inertia` to help browsers correctly differentiate between HTML and JSON responses.
</ParamField>

The following headers are used for [Precognition](/v2/the-basics/forms#precognition) validation responses.

<ParamField header="Precognition" type="string">
Set to `true` to indicate this is a Precognition validation response.
</ParamField>

<ParamField header="Precognition-Success" type="string">
Set to `true` when validation passes with no errors, combined with a `204 No Content` status code.
</ParamField>

<ParamField header="Vary" type="string">
Set to `Precognition` on all responses when the Precognition middleware is applied.
</ParamField>

## The Page Object

Inertia shares data between the server and client via a page object. This object includes the necessary information required to render the page component, update the browser's history state, and track the site's asset version. The page object can include the following properties:
Expand Down Expand Up @@ -442,3 +466,10 @@ Inertia uses specific HTTP status codes to handle different scenarios.
| **302 Found** | Standard redirect response. Inertia's server-side adapters automatically convert this to `303 See Other` when returned after `PUT`, `PATCH`, or `DELETE` requests. |
| **303 See Other** | Used for redirects after non-GET requests. This status code tells the browser to make a `GET` request to the redirect URL, preventing duplicate form submissions that could occur if the browser repeated the original request method. |
| **409 Conflict** | Returned when there's an asset version mismatch or for external redirects. For asset mismatches, this prompts a full page reload. For external redirects, the response includes an `X-Inertia-Location` header and triggers a `window.location` redirect client-side. |

The following status codes are used for [Precognition](/v2/the-basics/forms#precognition) validation requests.

| Status Code | Description |
|:------------------------------|:------------------------------------------------------------------------------------------------|
| **204 No Content** | Successful Precognition validation request with no validation errors. |
| **422 Unprocessable Entity** | Precognition validation request with validation errors. The response body contains the errors. |
Loading