Skip to content
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

Jump to bottom

Update api-reference.mdx #8373

Merged
merged 3 commits into from
May 23, 2024
Merged

Update api-reference.mdx #8373

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a9acd99
Update api-reference.mdx
hfournier May 22, 2024
622529e
Sarah edit to work content into text, remove note
sarah11918 May 23, 2024
640a6f5
Merge branch 'main' into patch-1
sarah11918 May 23, 2024
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
6 changes: 5 additions & 1 deletion src/content/docs/en/reference/api-reference.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -369,9 +369,13 @@ If true, the cookie is only set on https sites.
Allows customizing how the cookie is serialized.

### `Astro.redirect()`
`Astro.redirect()` allows you to redirect to another page.

Allows you to redirect to another page, and optionally provide an [HTTP response status code](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status) as a second parameter.

A page (and not a child component) must `return` the result of `Astro.redirect()` for the redirect to occur.

The following example redirects a user to a login page, using the default HTTP response status code 302:

```astro title="src/pages/account.astro" {8}
---
import { isLoggedIn } from '../utils';
Expand Down
Loading