parth
v4.2.3
Published
path to regex madness
Downloads
132
Maintainers
Readme
parth
documentation - examples - install - todo - why
sample
var Parth = require('parth');
var parth = new Parth();
var props = {handle: function(){}};
parth.set('(get|post) /:page/:view', props)
.get('get /weekend/baby?query=string#hash user.10.beers now')
// =>
{
path: 'get /:page/:view',
stem: ':0(get|post) /:page/:view:qs(?:\\/?)?([?#][^\\/\s]*)?',
depth: 2,
regex: /^(get|post) \/([^?#.\/\s]+)\/([^?#.\/\s]+)(?:\/?)?([?#][^\/\s]*)?/,
match: 'get /weekend/baby?query=string#hash',
handle: [Function],
notFound: ' user.10.beers now',
params: {
page: 'weekend',
view: 'baby',
qs: '?query=string#hash'
}
}
documentation
The module.exports
a Parth
constructor
var Parth = require('parth');
which can take the options below
var parth = new Parth(options);
options type object
, can be
options.defaultRE
defaultregex
used if none is given after the params
example:
var parth = new Parth({ defaultRE: /[^\s\/?#]+/ });
parth.set('/page/:view') // no regex given after ":view"
.get('/page/10/?query=here')
// =>
{
path: '/page/:view/',
stem: '/page/:view:qs(?:\\/?)([?#][^\\/\\s]*)?',
depth: 2,
regex: /^\/page\/([^\s\/?#]+)(?:\/?)([?#][^\/\s]*)?/,
match: '/page/10/?query=here',
params: {
view: '10',
qs: '?query=here'
},
notFound: ''
}
NOTE: the query string is separated by default and assigned to
qs
. This will only happen if the path given toparth.set
has no query string
parth.set
function set(string path[, object options])
This method job is to sanitize path
and order it with those previously stored.
arguments
path
, typestring
, path to be setoptions
, typeobject
, to merge with this path properties
returns this
NOTE:
options
is deep cloned beforehand to avoid mutation
path
can contain any number of parameters(regexes) in the form
:param-label(\\regexp(?:here))
Any string matching the regular expression below qualifies as a parameter
/:([-\w]+)(\([^\s]+?[)][?)]*)?/g;
Go to http://regexr.com/ and test it out.
parth.get
function get(string path)
Take a string and return a clone of the store object properties
arguments
path
, typestring
to match stored paths with
return
- null for non-supported types or not matching paths
- object with all the information stored in
parth.set
All matches are partial i.e. /^regex baby/. Not being strict is useful for
notFound
paths.NOTE: the returned object is a deep copy of the original
options
given inparth.set
to avoid mutation
parth properties
parth.store
: all paths set for match are hereparth.regex
: array of carefully ordered regexesparth.regex.master
: regex aggregating all learned
why
I need it for the gulp-runtime module.
install
With npm
npm install --save parth
examples
Run the example.js
file.
test
npm test
➜ parth (master) ✓ npm t
parth
paths
✓ object
✓ raw object paths
✓ unix paths
✓ raw unix paths
✓ urls
✓ raw urls
✓ urls: querystring is stripped
✓ urls: hash is stripped
✓ urls: parameters are not mistaken as querystrings
✓ space separated paths
✓ raw, space separated paths
✓ unix, object and url paths together
✓ raw: unix, object and urls paths together
params
✓ can be given as a string regex
✓ will contain all parameter keys at _
✓ parameter values should be at params
notFound
✓ should be false for perfect match
✓ should have what is left of the path
18 passing (16ms)
todo
- [ ] set support for regexp input
license
The MIT License (MIT)
Copyright (c) 2014-present Javier Carrillo
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.