path-to-regexp 2.1.0 → 2.2.0

package/History.md

@@ -1,3 +1,14 @@
+2.1.0 / 2018-03-06
+==================
+
+  * Pass `token` as second argument to `encode` option (e.g. `encode(value, token)`)
+
+2.1.0 / 2017-10-20
+==================
+
+  * Handle non-ending paths where the final character is a delimiter
+    * E.g. `/foo/` before required either `/foo/` or `/foo//` to match in non-ending mode
+
 2.0.0 / 2017-08-23
 ==================
 

package/Readme.md

@@ -61,15 +61,7 @@ re.exec('/test/route')
 //=> ['/test/route', 'test', 'route']
 ```
 
-**Please note:** Named parameters must be made up of "word characters" (`[A-Za-z0-9_]`).
-
-```js
-var re = pathToRegexp('/(apple-)?icon-:res(\\d+).png')
-// keys = [{ name: 0, prefix: '/', ... }, { name: 'res', prefix: '', ... }]
-
-re.exec('/icon-76.png')
-//=> ['/icon-76.png', undefined, '76']
-```
+**Please note:** Parameter names must be made up of "word characters" (`[A-Za-z0-9_]`).
 
 #### Parameter Modifiers
 
@@ -120,18 +112,18 @@ re.exec('/bar/baz')
 //=> ['/bar/baz', 'bar/baz']
 ```
 
-#### Custom Match Parameters
+#### Custom Matching Parameters
 
-All parameters can be provided a custom regexp, which overrides the default (`[^\/]+`).
+All parameters can be provided a custom regexp, which overrides the default match (`[^\/]+`). For example, you can match digits in the path:
 
 ```js
-var re = pathToRegexp('/:foo(\\d+)')
+var re = pathToRegexp('/icon-:foo(\\d+).png')
 // keys = [{ name: 'foo', ... }]
 
-re.exec('/123')
-//=> ['/123', '123']
+re.exec('/icon-123.png')
+//=> ['/icon-123.png', '123']
 
-re.exec('/abc')
+re.exec('/icon-abc.png')
 //=> null
 ```
 
@@ -180,7 +172,7 @@ toPath({ id: 'café' }) //=> "/user/caf%C3%A9"
 toPath({ id: '/' }) //=> "/user/%2F"
 
 toPath({ id: ':/' }) //=> "/user/%3A%2F"
-toPath({ id: ':/' }, { encode: (x) => x }) //=> "/user/:/"
+toPath({ id: ':/' }, { encode: (value, token) => value }) //=> "/user/:/"
 
 var toPathRepeated = pathToRegexp.compile('/:segment+')
 

package/index.d.ts

@@ -69,7 +69,7 @@ declare namespace pathToRegexp {
     /**
      * Function for encoding input strings for output.
      */
-    encode?: (value: string) => string;
+    encode?: (value: string, token: Key) => string;
   }
 
   export type Token = string | Key;

package/index.js

@@ -161,7 +161,7 @@ function tokensToFunction (tokens) {
         }
 
         for (var j = 0; j < value.length; j++) {
-          segment = encode(value[j])
+          segment = encode(value[j], token)
 
           if (!matches[i].test(segment)) {
             throw new TypeError('Expected all "' + token.name + '" to match "' + token.pattern + '"')
@@ -174,7 +174,7 @@ function tokensToFunction (tokens) {
       }
 
       if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
-        segment = encode(String(value))
+        segment = encode(String(value), token)
 
         if (!matches[i].test(segment)) {
           throw new TypeError('Expected "' + token.name + '" to match "' + token.pattern + '", but got "' + segment + '"')

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "path-to-regexp",
   "description": "Express style path to RegExp utility",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "main": "index.js",
   "typings": "index.d.ts",
   "files": [