mirror of https://github.com/coder/code-server.git
docs: clarify redirect function in http.ts usage
This commit is contained in:
parent
2092f82270
commit
2ba03c3424
|
@ -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).
|
* `override` will merge with the existing query (use `undefined` to unset).
|
||||||
*/
|
*/
|
||||||
export const redirect = (
|
export const redirect = (
|
||||||
|
|
Loading…
Reference in New Issue