docs: clarify redirect function in http.ts usage

This commit is contained in:
Joe Previte 2021-06-30 10:37:46 -07:00
parent 2092f82270
commit 2ba03c3424
No known key found for this signature in database
GPG Key ID: 2C91590C6B742C24
1 changed files with 2 additions and 1 deletions

View File

@ -100,7 +100,8 @@ export const relativeRoot = (req: express.Request): string => {
}
/**
* Redirect relatively to `/${to}`. Query variables will be preserved.
* Redirect relatively to `/${to}`. Query variables on the current URI will be preserved.
* `to` should be a simple path without any query parameters
* `override` will merge with the existing query (use `undefined` to unset).
*/
export const redirect = (