Handle asterisk matches in the compile function (#83)

Author: blakeembrey

Readme.md

@@ -207,6 +207,17 @@ Path-To-RegExp exposes the two functions used internally that accept an array of
 * `pathToRegexp.tokensToRegExp(tokens, options)` Transform an array of tokens into a matching regular expression.
 * `pathToRegexp.tokensToFunction(tokens)` Transform an array of tokens into a path generator function.
 
+#### Token Information
+
+* `name` The name of the token (`string` for named or `number` for index)
+* `prefix` The prefix character for the segment (`/` or `.`)
+* `delimiter` The delimiter for the segment (same as prefix or `/`)
+* `optional` Indicates the token is optional (`boolean`)
+* `repeat` Indicates the token is repeated (`boolean`)
+* `partial` Indicates this token is a partial path segment (`boolean`)
+* `pattern` The RegExp used to match this token (`string`)
+* `asterisk` Indicates the token is an `*` match (`boolean`)
+
 ## Compatibility with Express <= 4.x
 
 Path-To-RegExp breaks compatibility with Express <= `4.x`:

index.d.ts

@@ -41,9 +41,10 @@ declare namespace pathToRegexp {
     prefix: string;
     delimiter: string;
     optional: boolean;
-    partial: boolean;
     repeat: boolean;
     pattern: string;
+    partial: boolean;
+    asterisk: boolean;
   }
 
   interface PathFunctionOptions {

index.js

@@ -80,6 +80,7 @@ function parse (str) {
       optional: optional,
       repeat: repeat,
       partial: partial,
+      asterisk: !!asterisk,
       pattern: escapeGroup(pattern)
     })
   }
@@ -108,13 +109,25 @@ function compile (str) {
 }
 
 /**
- * Encode characters for segment that could cause trouble for parsing.
+ * Prettier encoding of URI path segments.
  *
  * @param  {string}
  * @return {string}
  */
 function encodeURIComponentPretty (str) {
-  return encodeURI(str).replace(/[/?#'"]/g, function (c) {
+  return encodeURI(str).replace(/[\/?#]/g, function (c) {
+    return '%' + c.charCodeAt(0).toString(16).toUpperCase()
+  })
+}
+
+/**
+ * Encode the asterisk parameter. Similar to `pretty`, but allows slashes.
+ *
+ * @param  {string}
+ * @return {string}
+ */
+function encodeAsterisk (str) {
+  return encodeURI(str).replace(/[?#]/g, function (c) {
     return '%' + c.charCodeAt(0).toString(16).toUpperCase()
   })
 }
@@ -166,7 +179,7 @@ function tokensToFunction (tokens) {
 
       if (isarray(value)) {
         if (!token.repeat) {
-          throw new TypeError('Expected "' + token.name + '" to not repeat, but received "' + value + '"')
+          throw new TypeError('Expected "' + token.name + '" to not repeat, but received `' + JSON.stringify(value) + '`')
         }
 
         if (value.length === 0) {
@@ -181,7 +194,7 @@ function tokensToFunction (tokens) {
           segment = encode(value[j])
 
           if (!matches[i].test(segment)) {
-            throw new TypeError('Expected all "' + token.name + '" to match "' + token.pattern + '", but received "' + segment + '"')
+            throw new TypeError('Expected all "' + token.name + '" to match "' + token.pattern + '", but received `' + JSON.stringify(segment) + '`')
           }
 
           path += (j === 0 ? token.prefix : token.delimiter) + segment
@@ -190,7 +203,7 @@ function tokensToFunction (tokens) {
         continue
       }
 
-      segment = encode(value)
+      segment = token.asterisk ? encodeAsterisk(value) : encode(value)
 
       if (!matches[i].test(segment)) {
         throw new TypeError('Expected "' + token.name + '" to match "' + token.pattern + '", but received "' + segment + '"')
@@ -263,8 +276,9 @@ function regexpToRegexp (path, keys) {
         prefix: null,
         delimiter: null,
         optional: false,
-        partial: false,
         repeat: false,
+        partial: false,
+        asterisk: false,
         pattern: null
       })
     }