Skip to content

Commit

Permalink
fix(types): update Astro.redirect JSDoc comment (#11546)
Browse files Browse the repository at this point in the history
* fix(types): update Astro.redirect JSDoc comment

* add changeset
  • Loading branch information
ArmandPhilippot authored Jul 24, 2024
1 parent d942475 commit 7f26de9
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
5 changes: 5 additions & 0 deletions .changeset/mighty-mirrors-try.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'astro': patch
---

Remove "SSR Only" mention in `Astro.redirect` inline documentation and update reference link.
4 changes: 2 additions & 2 deletions packages/astro/src/@types/astro.ts
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,7 @@ export interface AstroGlobal<
* ```
*/
getActionResult: AstroSharedContext['getActionResult'];
/** Redirect to another page (**SSR Only**)
/** Redirect to another page
*
* Example usage:
* ```typescript
Expand All @@ -271,7 +271,7 @@ export interface AstroGlobal<
* }
* ```
*
* [Astro reference](https://docs.astro.build/en/guides/server-side-rendering/)
* [Astro reference](https://docs.astro.build/en/reference/api-reference/#astroredirect)
*/
redirect: AstroSharedContext['redirect'];
/**
Expand Down

0 comments on commit 7f26de9

Please sign in to comment.