Add noValidate support to path function (#178)

Author: helloyou2012

Readme.md

@@ -192,6 +192,7 @@ const toPathRegexp = pathToRegexp.compile('/user/:id(\\d+)')
 toPathRegexp({ id: 123 }) //=> "/user/123"
 toPathRegexp({ id: '123' }) //=> "/user/123"
 toPathRegexp({ id: 'abc' }) //=> Throws `TypeError`.
+toPathRegexp({ id: 'abc' }, { noValidate: true }) //=> "/user/abc"
 ```
 
 **Note:** The generated function will throw on invalid input. It will do all necessary checks to ensure the generated path is valid. This method only works with strings.

index.d.ts

@@ -73,6 +73,10 @@ declare namespace pathToRegexp {
      * Function for encoding input strings for output.
      */
     encode?: (value: string, token: Key) => string;
+    /**
+     * When `true` the function can produce an invalid (unmatched) path. (default: `false`)
+     */
+    noValidate?: boolean;
   }
 
   export type Token = string | Key;

index.js

@@ -137,6 +137,7 @@ function tokensToFunction (tokens) {
   return function (data, options) {
     var path = ''
     var encode = (options && options.encode) || encodeURIComponent
+    var noValidate = (options && options.noValidate) || false
 
     for (var i = 0; i < tokens.length; i++) {
       var token = tokens[i]
@@ -163,7 +164,7 @@ function tokensToFunction (tokens) {
         for (var j = 0; j < value.length; j++) {
           segment = encode(value[j], token)
 
-          if (!matches[i].test(segment)) {
+          if (!noValidate && !matches[i].test(segment)) {
             throw new TypeError('Expected all "' + token.name + '" to match "' + token.pattern + '"')
           }
 
@@ -176,7 +177,7 @@ function tokensToFunction (tokens) {
       if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
         segment = encode(String(value), token)
 
-        if (!matches[i].test(segment)) {
+        if (!noValidate && !matches[i].test(segment)) {
           throw new TypeError('Expected "' + token.name + '" to match "' + token.pattern + '", but got "' + segment + '"')
         }
 

test.ts

@@ -1051,6 +1051,7 @@ var TESTS: Test[] = [
     ],
     [
       [{ test: 'abc' }, null],
+      [{ test: 'abc' }, '/abc', { noValidate: true }],
       [{ test: '123' }, '/123']
     ]
   ],
@@ -1121,7 +1122,9 @@ var TESTS: Test[] = [
     ],
     [
       [{ route: '' }, null],
+      [{ route: '' }, '/', { noValidate: true }],
       [{ route: '123' }, null],
+      [{ route: '123' }, '/123', { noValidate: true }],
       [{ route: 'abc' }, '/abc']
     ]
   ],
@@ -1146,6 +1149,7 @@ var TESTS: Test[] = [
     [
       [{ route: 'this' }, '/this'],
       [{ route: 'foo' }, null],
+      [{ route: 'foo' }, '/foo', { noValidate: true }],
       [{ route: 'that' }, '/that']
     ]
   ],
@@ -1175,7 +1179,9 @@ var TESTS: Test[] = [
       [{ path: ['abc', 'xyz'] }, '/abc/xyz'],
       [{ path: ['xyz', 'abc', 'xyz'] }, '/xyz/abc/xyz'],
       [{ path: 'abc123' }, null],
-      [{ path: 'abcxyz' }, null]
+      [{ path: 'abc123' }, '/abc123', { noValidate: true }],
+      [{ path: 'abcxyz' }, null],
+      [{ path: 'abcxyz' }, '/abcxyz', { noValidate: true }],
     ]
   ],