Package Exports
- regexparam
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (regexparam) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
regexparam 
A tiny (285B) utility that converts route patterns into RegExp. Limited alternative to
path-to-regexp🙇
With regexparam, you may turn a pathing string (eg, /users/:id) into a regular expression.
An object with shape of { keys, pattern } is returned, where pattern is the RegExp and keys is an array of your parameter name(s) in the order that they appeared.
Unlike path-to-regexp, this module does not create a keys dictionary, nor mutate an existing variable. Also, this only ships a parser, which only accept strings. Similarly, and most importantly, regexparam only handles basic pathing operators:
- Static (
/foo,/foo/bar) - Parameter (
/:title,/books/:title,/books/:genre/:title) - Parameter w/ Suffix (
/movies/:title.mp4,/movies/:title.(mp4|mov)) - Optional Parameters (
/:title?,/books/:title?,/books/:genre/:title?) - Wildcards (
*,/books/*,/books/:genre/*)
This module exposes two module definitions:
- CommonJS:
dist/regexparam.js - ESModule:
dist/regexparam.mjs
Install
$ npm install --save regexparamUsage
const regexparam = require('regexparam');
// Example param-assignment
function exec(path, result) {
let i=0, out={};
let matches = result.pattern.exec(path);
while (i < result.keys.length) {
out[ result.keys[i] ] = matches[++i] || null;
}
return out;
}
// Parameter, with Optional Parameter
// ---
let foo = regexparam('/books/:genre/:title?')
// foo.pattern => /^\/books\/([^\/]+?)(?:\/([^\/]+?))?\/?$/i
// foo.keys => ['genre', 'title']
foo.pattern.test('/books/horror'); //=> true
foo.pattern.test('/books/horror/goosebumps'); //=> true
exec('/books/horror', foo);
//=> { genre: 'horror', title: null }
exec('/books/horror/goosebumps', foo);
//=> { genre: 'horror', title: 'goosebumps' }
// Parameter, with suffix
// ---
let bar = regexparam('/movies/:title.(mp4|mov)');
// bar.pattern => /^\/movies\/([^\/]+?)\.(mp4|mov)\/?$/i
// bar.keys => ['title']
bar.pattern.test('/movies/narnia'); //=> false
bar.pattern.test('/movies/narnia.mp3'); //=> false
bar.pattern.test('/movies/narnia.mp4'); //=> true
exec('/movies/narnia.mp4', bar);
//=> { title: 'narnia' }
// Wildcard
// ---
let baz = regexparam('users/*');
// baz.pattern => /^\/users\/(.*)\/?$/i
// baz.keys => ['wild']
baz.pattern.test('/users'); //=> false
baz.pattern.test('/users/lukeed'); //=> true
exec('/users/lukeed/repos/new', baz);
//=> { wild: 'lukeed/repos/new' }Important: When matching/testing against a generated RegExp, your path must begin with a leading slash (
"/")!
API
regexparam(str, loose)
Returns: Object
str
Type: String
The route/pathing string to convert.
Note: It does not matter if your
strbegins with a/— it will be added if missing.
loose
Type: Boolean
Default: false
Should the RegExp match URLs that are longer than the str pattern itself?
By default, the generated RegExp will test that the URL begins and ends with the pattern.
const rgx = require('regexparam');
rgx('/users').pattern.test('/users/lukeed'); //=> false
rgx('/users', true).pattern.test('/users/lukeed'); //=> true
rgx('/users/:name').pattern.test('/users/lukeed/repos'); //=> false
rgx('/users/:name', true).pattern.test('/users/lukeed/repos'); //=> trueRelated
- trouter - A server-side HTTP router that extends from this module.
- matchit - Similar (650B) library, but relies on String comparison instead of
RegExps.
License
MIT © Luke Edwards