Skip to content

Commit

Permalink
fix(docs): clarify redirectInBrowser option (#32669)
Browse files Browse the repository at this point in the history
Make clear that this isn't generally what people want.
  • Loading branch information
KyleAMathews committed Aug 2, 2021
1 parent 5f406a9 commit 774e680
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion packages/gatsby/src/redux/actions/public.js
Expand Up @@ -1357,7 +1357,7 @@ const maybeAddPathPrefix = (path, pathPrefix) => {
* @param {string} redirect.fromPath Any valid URL. Must start with a forward slash
* @param {boolean} redirect.isPermanent This is a permanent redirect; defaults to temporary
* @param {string} redirect.toPath URL of a created page (see `createPage`)
* @param {boolean} redirect.redirectInBrowser Redirects are generally for redirecting legacy URLs to their new configuration. If you can't update your UI for some reason, set `redirectInBrowser` to true and Gatsby will handle redirecting in the client as well.
* @param {boolean} redirect.redirectInBrowser Redirects are generally for redirecting legacy URLs to their new configuration on the server. If you can't update your UI for some reason, set `redirectInBrowser` to true and Gatsby will handle redirecting in the client as well. You almost never need this so be sure your use case fits before enabling.
* @param {boolean} redirect.force (Plugin-specific) Will trigger the redirect even if the `fromPath` matches a piece of content. This is not part of the Gatsby API, but implemented by (some) plugins that configure hosting provider redirects
* @param {number} redirect.statusCode (Plugin-specific) Manually set the HTTP status code. This allows you to create a rewrite (status code 200) or custom error page (status code 404). Note that this will override the `isPermanent` option which also sets the status code. This is not part of the Gatsby API, but implemented by (some) plugins that configure hosting provider redirects
* @param {boolean} redirect.ignoreCase (Plugin-specific) Ignore case when looking for redirects
Expand Down

0 comments on commit 774e680

Please sign in to comment.