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.

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

docs: added most common status codes to redirect() doc #13301

Merged
merged 4 commits into from
Jan 15, 2025

Conversation

GauBen
Copy link
Contributor

@GauBen GauBen commented Jan 12, 2025

Hey! Small QOL improvement, I often google HTTP status codes to know which one I should use. I picked the three values that should cover 99% of use cases; 302 Found is not in there because its behavior is disambiguated by 303 and 307.


Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.

Tests

  • Run the tests with pnpm test and lint the project with pnpm lint and pnpm check

Changesets

  • If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

Edits

  • Please ensure that 'Allow edits from maintainers' is checked. PRs without this option may be closed.

Copy link

changeset-bot bot commented Jan 12, 2025

🦋 Changeset detected

Latest commit: 2810e2b

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@sveltejs/kit Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@Rich-Harris
Copy link
Member

preview: https://svelte-dev-git-preview-kit-13301-svelte.vercel.app/

this is an automated message

@eltigerchino eltigerchino added the documentation Improvements or additions to documentation label Jan 13, 2025
Comment on lines +90 to +91
* * `307 Temporary Redirect`: redirect will keep the request method
* * `308 Permanent Redirect`: redirect will keep the request method, SEO will be transferred to the new page
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not entirely confident that 307 doesn't have some SEO implications. I'd simplify it to remove that

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Search engines receiving this response will not attribute links to the original URL to the new resource, meaning no SEO value is transferred to the new URL.

Per MDN, although this is not a guarantee of any kind on Google's end

@benmccann
Copy link
Member

I think the whole text could be squashed down to something like "Prefer 307 for temporary redirects and 308 for permanent redirects."

@GauBen
Copy link
Contributor Author

GauBen commented Jan 13, 2025

Thanks for the review! I believe 303 is the best choice for post-action redirect, and that's what we can see in the docs too!

packages/kit/src/exports/index.js Outdated Show resolved Hide resolved
Copy link
Contributor Author

@GauBen GauBen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

consistency for http verbs

packages/kit/src/exports/index.js Outdated Show resolved Hide resolved
packages/kit/types/index.d.ts Outdated Show resolved Hide resolved
@dummdidumm dummdidumm merged commit 9fcd1e7 into sveltejs:main Jan 15, 2025
14 checks passed
@github-actions github-actions bot mentioned this pull request Jan 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants