From 2ba03c3424144ce625a328c95251553597d9c460 Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Wed, 30 Jun 2021 10:37:46 -0700 Subject: [PATCH] docs: clarify redirect function in http.ts usage --- src/node/http.ts | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/node/http.ts b/src/node/http.ts index 87a0be108..76eb52073 100644 --- a/src/node/http.ts +++ b/src/node/http.ts @@ -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 = (