From f7a6bc4f6a8d52d335c02463f5fbc2d52cf30149 Mon Sep 17 00:00:00 2001 From: Dorian Niemiec Date: Wed, 1 Jan 2025 21:04:22 +0100 Subject: [PATCH] docs: add note about request URL not being rewritten in SVRouter --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 938ac84..b59754d 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,7 @@ Parameters: Returns: the SVRouter router (so that you can chain the methods for routes or pass-throughs) -The function adds a pass-through (can be middleware) to the SVRouter router. The pass-through can be to an another SVRouter router (the absolute request URLs need to be provided for the _router.route_ function in the SVRouter router). +The function adds a pass-through (can be middleware) to the SVRouter router. The pass-through can be to an another SVRouter router (the absolute request URLs need to be provided for the _router.route_ function in the SVRouter router). Note that the request URL is not rewritten though, unlike in the `router` library, so if you write middleware for SVRouter, you may need to include the request URL prefix in the parameters of the function that returns the SVR.JS mod callback. The _callback_ parameter has these arguments of the SVR.JS mod callback: - _req_ - the SVR.JS request object