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 regexparam
Usage
const regexparam = require('regexparam');
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;
}
let foo = regexparam('/books/:genre/:title?')
foo.pattern.test('/books/horror');
foo.pattern.test('/books/horror/goosebumps');
exec('/books/horror', foo);
exec('/books/horror/goosebumps', foo);
let bar = regexparam('/movies/:title.(mp4|mov)');
bar.pattern.test('/movies/narnia');
bar.pattern.test('/movies/narnia.mp3');
bar.pattern.test('/movies/narnia.mp4');
exec('/movies/narnia.mp4', bar);
let baz = regexparam('users/*');
baz.pattern.test('/users');
baz.pattern.test('/users/lukeed');
exec('/users/lukeed/repos/new', baz);
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 str
begins 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');
rgx('/users', true).pattern.test('/users/lukeed');
rgx('/users/:name').pattern.test('/users/lukeed/repos');
rgx('/users/:name', true).pattern.test('/users/lukeed/repos');
Related
- trouter - A server-side HTTP router that extends from this module.
- matchit - Similar (650B) library, but relies on String comparison instead of
RegExp
s.
License
MIT © Luke Edwards