path-to-regexp

What are path-to-regexp's main functionalities?

const { pathToRegexp } = require('path-to-regexp');
const keys = [];
const regexp = pathToRegexp('/user/:id', keys);

const { match } = require('path-to-regexp');
const matchFn = match('/user/:id');
const result = matchFn('/user/123');
// result.params will contain the extracted parameters

const { compile } = require('path-to-regexp');
const toPath = compile('/user/:id');
const path = toPath({ id: 123 });
// path will be '/user/123'

Path-to-RegExp

Turn an Express-style path string such as /user/:name into a regular expression.

Note: This is a legacy branch. You should upgrade to 1.x.

Usage

var pathToRegexp = require('path-to-regexp');

pathToRegexp(path, keys, options)

• path A string in the express format, an array of such strings, or a regular expression
• keys An array to be populated with the keys present in the url. Once the function completes, this will be an array of strings.
• options
  • options.sensitive Defaults to false, set this to true to make routes case sensitive
  • options.strict Defaults to false, set this to true to make the trailing slash matter.
  • options.end Defaults to true, set this to false to only match the prefix of the URL.

var keys = [];
var exp = pathToRegexp('/foo/:bar', keys);
//keys = ['bar']
//exp = /^\/foo\/(?:([^\/]+?))\/?$/i

Live Demo

You can see a live demo of this library in use at express-route-tester.

License

MIT