A small utility to parse, match and generate paths
npm install path-parser

A small library to parse and build paths. It can be used to partially or fully
test paths against a defined pattern.
Partial testing allows to determine if a given path starts with the defined pattern.
It is used by route-node
``javascript
import { Path } from 'path-parser'
// or
const { Path } = require('path-parser')
const path = new Path('/users/:id')
// Matching
path.test('/users/00123')
// {
// id: "00123"
// }
// Partial testing: does the provided path
// starts with the defined pattern?
path.partialTest('/users/00123/orders')
// {
// id: "00123"
// }
path.partialTest('/profile/00123/orders')
// null
// Building
path.build({ id: '00123' })
// => "/users/00123"
`
Without new:
`javascript`
const path = Path.createPath('/users/:id')
- :param: for URL parameters;param
- : for matrix parameters*splat
- : for parameters spanning over multiple segments. Handle with care?param1¶m2
- or ?:param1&:param2: for query parameters. Colons : are optional.
#### Parameter constraints
For URL parameters and matrix parameters, you can add a constraint in the form of a regular expression.
Note that back slashes have to be escaped.
- :param<\\d+> will match numbers only for parameter param;id<[a-fA-F0-9]{8}
- will match 8 characters hexadecimal strings for parameter id
Constraints are also applied when building paths, unless specified otherwise (set option flag ignoreConstraints to true).
`javascript
// Path.build(params, opts)
var Path = new Path('/users/:id
path.build({ id: 'not-a-number' }) // => Will throw an error
path.build({ id: '123' }) // => '/users/123'
`
A path instance can be created two ways:
- new Path(path: string, opts?: object): objectPath.create(path: string, opts?: object): object
-
Options available are:
- 'queryParams': options for query parameters'urlParamsEncoding
- , to specify how URL parameters are encoded and decoded:'default':
- encodeURIComponentanddecodeURIComponentare used but some characters to encode and decode URL parameters, but some characters are preserved when encoding (sub-delimiters:+,:,',!,,,;,'\*').
- 'uriComponent': use encodeURIComponent and decodeURIComponent
for encoding and decoding URL parameters.
- 'uri': use encodeURI and decodeURI for encoding amd decoding'none'
URL parameters.
- : no encoding or decoding is performed'legacy'
- : the approach for version 5.x and below (not recoomended)
Test if the provided path matches the defined path template. Options available are:
- 'caseSensitive': whether matching should be case sensitive or not (default to false)'strictTrailingSlash'
- : whether or not it should strictly match trailing slashes (default to false)
Test if the provided path is partially matched (starts with) the defined path template. Options available are:
- 'caseSensitive': whether matching should be case sensitive or not (default to false)'delimited'
- : whether or not a partial match should only be successful if it reaches a delimiter (/, ?, . and ;). Default to true.'queryParams'
- : to overwrite query parameter options (see above)'urlParamsEncoding
- : to overwrite URL param encoding and decoding option (see above)
Builds the defined path template with the provided parameters
- 'caseSensitive': whether matching should be case sensitive or not (default to false)'ignoreConstraints'
- : whether or not to ignore parameter constraints (default to false)'ignoreSearch'
- : whether or not to build query parameters (default to false)'queryParams'
- : to overwrite query parameter options (see above)'urlParamsEncoding`: to overwrite URL param encoding and decoding option (see above)
-