GitHub - lukeed/regexparam: A tiny (299B) utility that converts route patterns i...
source link: https://github.com/lukeed/regexparam
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
readme.md
regexparam
A tiny (299B) 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. Simiarly, and most importantly, regexparam
only handles basic pathing operators:
- Static (
/foo
,/foo/bar
) - Parameter (
/:title
,/books/:title
,/books/:genre/:title
) - Optional Parameters (
/:title?
,/books/:title?
,/books/:genre/:title?
) - Wildcards (
*
,/books/*
,/books/:genre/*
)
Lastly, please note that while this route-parser is not slow, you should use matchit
or trouter
if performance is of critical importance. This is epsecially true for backend/server scenarios!
This module exposes two module definitions:
- ES Module:
dist/regexparam.es.js
- CommonJS:
dist/regexparam.js
Install
$ npm install --save regexparam
Usage
const regexparam = require('regexparam'); let foo = regexparam('users/*'); // foo.keys => ['wild'] // foo.pattern => /^\/users\/(.*)(?:\/)?\/?$/i let bar = regexparam('/books/:genre/:title?') // bar.keys => ['genre', 'title'] // bar.pattern => /^\/books\/([^\/]+?)(?:\/([^\/]+?))?(?:\/)?\/?$/i bar.pattern.test('/books/horror'); //=> true bar.pattern.test('/books/horror/goosebumps'); //=> true // 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; } exec('/books/horror', bar); //=> { genre:'horror', title:null } exec('/books/horror/goosebumps', bar); //=> { genre:'horror', title:'goosebumps' }
Important: When matching/testing against a generated RegExp, your path must begin with a leading slash (
"/"
)!
API
regexparam(str)
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.
License
MIT © Luke Edwards
Recommend
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK