docs: clarify redirect function in http.ts usage

jsjoeio · jsjoeio · commit 4ba52d7a14cf · 2021-06-30T10:37:46.000-07:00
diff --git 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 = (

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