Edit Page
res.redirect()
Redirect the requesting user agent to the given absolute or relative URL.
Usage
return res.redirect(url);
Or:
return res.redirect(statusCode, url);
Arguments
| Argument | Type | Details | |
|---|---|---|---|
| 1 | statusCode | An optional status code (e.g. 301). (If omitted, a status code of 302 will be assumed.) | |
| 2 | url | A URL expression (see below for complete specification). e.g. "http://google.com" or "/login" |
Details
Sails/Express support a few forms of redirection:
- A fully qualified URI for redirecting to a different domain:
return res.redirect('http://google.com');
- The domain-relative redirect. For example, if you were on http://example.com/admin/post/new, the following redirect to
/checkoutwould land you at http://example.com/checkout:
return res.redirect('/checkout');
- Pathname-relative redirects. If you were on http://example.com/admin/post/new, the following redirect would land you at http//example.com/admin/post:
return res.redirect('..');
- A back redirect, which allows you to redirect a request back from whence it came from using the "Referer" (or "Referrer") header (if omitted, redirects to
/by default):
return res.redirect('back');
Notes
- This method is terminal, meaning that it is generally the last line of code your app should run for a given request (hence the advisory usage of
returnthroughout these docs).- As of Sails v1.x, for HTTP requests,
res.redirect()does not respect the status code established byres.status(). Thanks @Guillaume-Duval and @oshatrk!- When your app calls
res.redirect(), Sails sends a response with status code 302, indicating a temporary redirect. This instructs the user agent to send a new request to the indicated URL. There is no way to force a user agent to follow redirects, but most clients play nicely.- In general, you should not need to use
res.redirect()if a request "wants JSON" (i.e.req.wantsJSON).- If a request originated from the Sails socket client, it always "wants JSON", so the Sails socket client does not follow redirects. For this reason, if an action is called via a WebSocket request using (for example)
io.socket.get(), it will simply receive the appropriate status code and a "Location" header indicating the location of the desired resource. It’s up to the client-side code to decide how to handle redirects for WebSocket requests.
For a better experience on sailsjs.com, update your browser.
Reference
- Application
- Blueprint API
- Command-line interface
-
Configuration
- sails.config.*
- sails.config.blueprints
- sails.config.bootstrap()
- sails.config.custom
- sails.config.datastores
- sails.config.globals
- sails.config.http
- sails.config.i18n
- sails.config.log
- sails.config.models
- sails.config.policies
- sails.config.routes
- sails.config.security
- sails.config.session
- sails.config.sockets
- sails.config.views
-
Request (`req`)
- req._startTime
- req.body
- req.cookies
- req.fresh
- req.headers
- req.hostname
- req.ip
- req.ips
- req.isSocket
- req.method
- req.options
- req.originalUrl
- req.params
- req.path
- req.protocol
- req.query
- req.secure
- req.signedCookies
- req.socket
- req.subdomains
- req.url
- req.wantsJSON
- req.xhr
- req.accepts()
- req.acceptsCharsets()
- req.acceptsLanguages()
- req.allParams()
- req.file()
- req.get()
- req.is()
- req.param()
- req.setLocale()
- req.setTimeout()
- req.host
- Response (`res`)
- Waterline (ORM)
- WebSockets
Built with Love
The Sails framework is built by a web & mobile shop in Austin, TX, with the help of our contributors. We created Sails in 2012 to assist us on Node.js projects. Naturally we open-sourced it. We hope it makes your life a little bit easier!
© 2012-2021 The Sails Company.
The Sails framework is free and open-source under the MIT License.
Illustrations by Edamame.