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

Add info to SSR page on using Astro.response #8011

Merged
merged 5 commits into from May 1, 2024
Merged

Add info to SSR page on using Astro.response #8011

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
84e4fec
Add detail on using Astro.response
ascorbic Apr 25, 2024
1179eeb
Fix link
ascorbic Apr 25, 2024
744219d
Fix header depth
ascorbic Apr 25, 2024
3ab7cea
Apply suggestions from code review
ascorbic Apr 30, 2024
eed8d47
Merge branch 'main' into astro-response
sarah11918 May 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
38 changes: 37 additions & 1 deletion src/content/docs/en/guides/server-side-rendering.mdx
View file
Open in desktop
Expand Up @@ -222,7 +222,43 @@ See more details about [`Astro.cookies` and the `AstroCookie` type](/en/referenc

### `Response`

You can also return a [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) from any page using on-demand rendering.
[`Astro.response`](/en/reference/api-reference/#astroresponse) is a standard [`ResponseInit`](https://developer.mozilla.org/en-US/docs/Web/API/Response/Response#options) object. It can be used to set the response status and headers.

The example below sets a response status and status text for a product listing page when the product does not exist:

```astro title="src/pages/my-product.astro" {8-9}
---
import { getProduct } from '../api';

const product = await getProduct(Astro.params.id);

// No product found
if (!product) {
Astro.response.status = 404;
Astro.response.statusText = 'Not found';
}
---
<html>
<!-- Page here... -->
</html>
```

#### `Astro.response.headers`

You can set headers using the `Astro.response.headers` object:

```astro title="src/pages/index.astro" {2}
---
Astro.response.headers.set('Cache-Control', 'public, max-age=3600');
---
<html>
<!-- Page here... -->
</html>
```

#### Return a `Response` object

You can also return a [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) object directly from any page using on-demand rendering.

The example below returns a 404 on a dynamic page after looking up an id in the database:

Expand Down