Encode using identity function by default

Author: blakeembrey

src/index.spec.ts

@@ -189,9 +189,9 @@ const TESTS: Test[] = [
     [
       [{}, null],
       [{ test: "abc" }, "/abc"],
-      [{ test: "a+b" }, "/a+b", { encode: value => value }],
+      [{ test: "a+b" }, "/a+b"],
       [{ test: "a+b" }, "/test", { encode: (_, token) => String(token.name) }],
-      [{ test: "a+b" }, "/a%2Bb"]
+      [{ test: "a+b" }, "/a%2Bb", { encode: encodeURIComponent }]
     ]
   ],
   [
@@ -285,9 +285,9 @@ const TESTS: Test[] = [
     [
       [{}, null],
       [{ test: "abc" }, "/abc"],
-      [{ test: "a+b" }, "/a+b", { encode: value => value }],
+      [{ test: "a+b" }, "/a+b"],
       [{ test: "a+b" }, "/test", { encode: (_, token) => String(token.name) }],
-      [{ test: "a+b" }, "/a%2Bb"]
+      [{ test: "a+b" }, "/a%2Bb", { encode: encodeURIComponent }]
     ]
   ],
   [
@@ -576,8 +576,16 @@ const TESTS: Test[] = [
     ],
     [
       [{ test: "route" }, "/route"],
-      [{ test: "something/else" }, "/something%2Felse"],
-      [{ test: "something/else/more" }, "/something%2Felse%2Fmore"]
+      [
+        { test: "something/else" },
+        "/something%2Felse",
+        { encode: encodeURIComponent }
+      ],
+      [
+        { test: "something/else/more" },
+        "/something%2Felse%2Fmore",
+        { encode: encodeURIComponent }
+      ]
     ]
   ],
   [
@@ -1050,8 +1058,12 @@ const TESTS: Test[] = [
     [
       [{ test: "" }, "/"],
       [{ test: "abc" }, "/abc"],
-      [{ test: "abc/123" }, "/abc%2F123"],
-      [{ test: "abc/123/456" }, "/abc%2F123%2F456"]
+      [{ test: "abc/123" }, "/abc%2F123", { encode: encodeURIComponent }],
+      [
+        { test: "abc/123/456" },
+        "/abc%2F123%2F456",
+        { encode: encodeURIComponent }
+      ]
     ]
   ],
   [
@@ -2059,7 +2071,7 @@ const TESTS: Test[] = [
     ],
     [
       [{ foo: "foo" }, "/foobaz"],
-      [{ foo: "foo/bar" }, "/foo%2Fbarbaz"],
+      [{ foo: "foo/bar" }, "/foo%2Fbarbaz", { encode: encodeURIComponent }],
       [{ foo: ["foo", "bar"] }, "/foo/barbaz"]
     ]
   ],
@@ -2236,7 +2248,10 @@ const TESTS: Test[] = [
       }
     ],
     [["/café", ["/café", "café"]]],
-    [[{ foo: "café" }, "/caf%C3%A9"]]
+    [
+      [{ foo: "café" }, "/café"],
+      [{ foo: "café" }, "/caf%C3%A9", { encode: encodeURIComponent }]
+    ]
   ],
   ["/café", undefined, ["/café"], [["/café", ["/café"]]], [[null, "/café"]]],
   [

src/index.ts

@@ -212,7 +212,7 @@ export function tokensToFunction<P extends object = object>(
   options: TokensToFunctionOptions = {}
 ): PathFunction<P> {
   const reFlags = flags(options);
-  const { encode = encodeURIComponent, validate = true } = options;
+  const { encode = (x: string) => x, validate = true } = options;
 
   // Compile all the tokens into regexps.
   const matches = tokens.map(token => {
@@ -452,7 +452,8 @@ export function tokensToRegexp(
     strict,
     start = true,
     end = true,
-    delimiter = DEFAULT_DELIMITER
+    delimiter = DEFAULT_DELIMITER,
+    encode = (x: string) => x
   } = options;
   const endsWith = (typeof options.endsWith === "string"
     ? options.endsWith.split("")
@@ -466,7 +467,7 @@ export function tokensToRegexp(
   // Iterate over the tokens and create our regexp string.
   for (const token of tokens) {
     if (typeof token === "string") {
-      route += escapeString(token);
+      route += escapeString(encode(token));
     } else {
       const capture = token.repeat
         ? `(?:${token.pattern})(?:${escapeString(token.delimiter)}(?:${
@@ -537,6 +538,10 @@ export interface RegexpOptions {
    * List of characters that can also be "end" characters.
    */
   endsWith?: string | string[];
+  /**
+   * Encode path tokens for use in the `RegExp`.
+   */
+  encode?: (value: string) => string;
 }
 
 export interface ParseOptions {