From 7f26de906e87f1e8973a1f84399f23e36e506bb3 Mon Sep 17 00:00:00 2001 From: Armand Philippot <59021693+ArmandPhilippot@users.noreply.github.com> Date: Wed, 24 Jul 2024 20:54:21 +0200 Subject: [PATCH] fix(types): update Astro.redirect JSDoc comment (#11546) * fix(types): update Astro.redirect JSDoc comment * add changeset --- .changeset/mighty-mirrors-try.md | 5 +++++ packages/astro/src/@types/astro.ts | 4 ++-- 2 files changed, 7 insertions(+), 2 deletions(-) create mode 100644 .changeset/mighty-mirrors-try.md diff --git a/.changeset/mighty-mirrors-try.md b/.changeset/mighty-mirrors-try.md new file mode 100644 index 000000000000..8198d9fe5046 --- /dev/null +++ b/.changeset/mighty-mirrors-try.md @@ -0,0 +1,5 @@ +--- +'astro': patch +--- + +Remove "SSR Only" mention in `Astro.redirect` inline documentation and update reference link. diff --git a/packages/astro/src/@types/astro.ts b/packages/astro/src/@types/astro.ts index 2c24f74b5386..ddffe51df4ad 100644 --- a/packages/astro/src/@types/astro.ts +++ b/packages/astro/src/@types/astro.ts @@ -262,7 +262,7 @@ export interface AstroGlobal< * ``` */ getActionResult: AstroSharedContext['getActionResult']; - /** Redirect to another page (**SSR Only**) + /** Redirect to another page * * Example usage: * ```typescript @@ -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']; /**