path-to-regex

path-to-regex

Turn a path string such as /user/:id or /user/:id(\d+) into a regular expression

Installation

npm install path-to-regex --save

Usage

var pathToRegex = require('path-to-regex');

var parser = new pathToRegex(path_template, options?);

• path_template A string or a regular expression.
• options
  • case When true the regexp will be case sensitive. (default: true)
  • separators The chars list for splited patch string. (default: '/')
  • fromStart When true the regexp will match from the beginning of the string. (default: true)
  • toEnd When true the regexp will match to the end of the string. (default: true)

How it works?

It is important to understand how the key :key is interpreted depending on the pattern :key(.*) used and quantifiers :key*. The following examples will help you understand the logic for obtaining key values.

the quantifier * will capture everything that is not a separator options.separators

let parser = new pathToRegex(':path*');              // parser.regexp:  /^[\/]?((?:[\/]?[^\/]+)*)[\/]?$/

let result = parser.match('user/id');                // result: { path: [ 'user', 'id' ] }
let result = parser.match('/user/id');               // result: { path: [ 'user', 'id' ] }
let result = parser.match('user/id/');               // result: { path: [ 'user', 'id' ] }
let result = parser.match('/user/id/');              // result: { path: [ 'user', 'id' ] }

let parser = new pathToRegex('/:path*');             // parser.regexp:  /^[\/]?((?:[\/]?[^\/]+)*)[\/]?$/

let result = parser.match('user/id');                // result: { path: [ 'user', 'id' ] }
let result = parser.match('/user/id');               // result: { path: [ 'user', 'id' ] }
let result = parser.match('user/id/');               // result: { path: [ 'user', 'id' ] }
let result = parser.match('/user/id/');              // result: { path: [ 'user', 'id' ] }

Pattern (...), in contrast quantifier, allows you to directly determine the valid key pattern. Such pattern (.*) will capture everything, including the splitter.

let parser = new pathToRegex(':path(.*)');           // parser.regexp:  /^[\/]?(.*?)[\/]?$/

let result = parser.match('user/id');                // result: { path: 'user/id' }
let result = parser.match('/user/id');               // result: { path: 'user/id' }
let result = parser.match('user/id/');               // result: { path: 'user/id' }
let result = parser.match('/user/id/');              // result: { path: 'user/id' }

let parser = new pathToRegex('/:path(.*)');          // parser.regexp:  /^[\/]?(.*?)[\/]?$/

let result = parser.match('user/id');                // result: { path: 'user/id' }
let result = parser.match('/user/id');               // result: { path: 'user/id' }
let result = parser.match('user/id/');               // result: { path: 'user/id' }
let result = parser.match('/user/id/');              // result: { path: 'user/id' }

Samples

The following examples clearly demonstrate the use of keys, their pattern quantifiers.

Demonstration of processing a key identifier with a specific content :keyname(\\d+)

let parser = new pathToRegex('/foo/:bar(\\d+)');            // parser.regexp:  /^[\/]?foo\/?(\d+?)[\/]?$/

let result = parser.match('/foo/123');                      // result: { bar: '123' }
let result = parser.match('/foo/asd');                      // result: undefined
let result = parser.match('/foo/123asd');                   // result: undefined
let result = parser.match('/foo/123/bar');                  // result: undefined

Demonstration of processing a multiple key identifiers :keyname1 ... :keyname2

let parser = new pathToRegex('/user/:foo/:bar');            // parser.regexp:  /^[\/]?user\/?([^\/]+?)\/?([^\/]+?)[\/]?$/

let result = parser.match('/user/123/asd');                 // result: { foo: '123', bar: 'asd' }
let result = parser.match('/user/asd/123');                 // result: { foo: 'asd', bar: '123' }

Demonstration of processing a key identifiers with a repeated names :keyname(\\d+) ... :keyname(\d+)

let parser = new pathToRegex('/foo/:bar/:bar');             // parser.regexp:  /^[\/]?foo\/?([^\/]+?)\/?([^\/]+?)[\/]?$/

let result = parser.match('/foo/123/asd');                  // result: { bar: [ '123', 'asd' ] }
let result = parser.match('/foo/asd/123');                  // result: { bar: [ 'asd', '123' ] }

Demonstration of processing a key identifier with a quantifier ?

let parser = new pathToRegex('/foo/:bar?');                 // parser.regexp:  /^[\/]?foo\/?([^\/]+?)?[\/]?$/

let result = parser.match('/foo/123');                      // result: { bar: '123' }
let result = parser.match('/foo/');                         // result: { bar: undefined }
let result = parser.match('/foo');                          // result: { bar: undefined }

Demonstration of processing a key identifier with all features

let parser = new pathToRegex('/user/:id/bar/:key(\\d+):post?fak/:key(\d+)*:foo+/test/pictures-:multi(\w+?\.png)*/:key?');               // parser.r/]+?)?fak\/((?:[^\/]*\d+)*)((?:[^\/]*[^\/]+)+)\/test\/pictures-((?:[^\/]*\w+?\.png)*)\/?([^\/]+?)?[\/]?$/

let result = parser.match('/user/123/bar/111qwertyfak/222foo/test/pictures-p01.png,p02.png,p03.png/333');               // result: { id: '123',
  key: [ '111', '222', '333' ],
  post: 'qwerty',
  foo: [ 'foo' ],
  multi: [ 'p01.png', 'p02.png', 'p03.png' ] }
let result = parser.match('/user/123/bar/111qwertyfak/222foo/test/pictures-p01.png-p02.png-p03.png');           // result: { id: '123',
  key: [ '111', '222' ],
  post: 'qwerty',
  foo: [ 'foo' ],
  multi: [ 'p01.png', 'p02.png', 'p03.png' ] }
let result = parser.match('/user/123/bar/111fak/222foo/test/pictures-p01.png,p02.png,p03.png');                 // result: { id: '123',
  key: [ '111', '222' ],
  post: undefined,
  foo: [ 'foo' ],
  multi: [ 'p01.png', 'p02.png', 'p03.png' ] }
let result = parser.match('/user/123/bar/111fak/foo/test/pictures-p01.png;p02.png;p03.png');            // result: { id: '123',
  key: [ '111' ],
  post: undefined,
  foo: [ 'foo' ],
  multi: [ 'p01.png', 'p02.png', 'p03.png' ] }
let result = parser.match('/user/123/bar/111fak/foo/test/pictures-p01.png p02.png');    // result: { id: '123',
  key: [ '111' ],
  post: undefined,
  foo: [ 'foo' ],
  multi: [ 'p01.png', 'p02.png' ] }
let result = parser.match('/user/123/bar/111fak/foo/test/pictures-p01.png');            // result: { id: '123',
  key: [ '111' ],
  post: undefined,
  foo: [ 'foo' ],
  multi: [ 'p01.png' ] }
let result = parser.match('/user/123/bar/111fak/foo/test/pictures-');                   // result: { id: '123',
  key: [ '111' ],
  post: undefined,
  foo: [ 'foo' ],
  multi: [] }

... documentation in processed

Participation in development

https://github.com/lastuniverse/path-to-regex/issues

License

MIT