Skip to content

docs: correct response.back() signature and behavior #1959

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.

Sign up for GitHub

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

Closed
Bojun-Vvibe wants to merge 1 commit into from
+11 −2
Closed

docs: correct response.back() signature and behavior #1959

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions docs/api/response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,9 +305,18 @@ ctx.redirect('/cart');
ctx.body = 'Redirecting to shopping cart';
```

### response.back(url)
### response.back([alt])

Redirect back to the URL in the `Referrer` header (only when it points to the
same host as the current request). When the `Referrer` header is missing, or
refers to a different host, redirects to `alt` instead, falling back to `/`
when `alt` is not provided.

```js
ctx.back();
ctx.back('/index.html');
```

Similar to `.redirect(url)`, but first checks the `referer` header to redirect.
This is new in v3 as `.redirect(url, alt)` removes the special case `url = 'back'` option.

### response.attachment([filename], [options])
Expand Down