Awesome
route-trie
A minimal and powerful trie based url path router for Node.js.
Golang Version
https://github.com/teambition/trie-mux
Trie-based request routing
route-trie is a trie-based URL router. Its goal is only to define and match URLs. It does not handle methods, headers, controllers, views, etc., in anyway. It is faster than traditional, linear, regular expression-matching routers, although insignficantly, and scales with the number of routes.
Implementations:
- toa-router A trie router for toa(server).
Features
- Support named parameter
- Support regexp
- Support suffix matching
- Fixed path automatic redirection
- Trailing slash automatic redirection
- Support
405 Method Not Allowed
- Best Performance
Installation
npm install route-trie
API
const { Trie, Node, Matched } = require('route-trie')
Class: Trie(options)
Create a trie instance.
options.ignoreCase
: {Boolean}, default totrue
, ignore case.options.fixedPathRedirect
: {Boolean}, default totrue
. If enabled, the trie will detect if the current path can't be matched but a handler for the fixed path exists. matched.fpr will returns either a fixed redirect path or an empty string. For example when "/api/foo" defined and matching "/api//foo", The result matched.fpr is "/api/foo".options.trailingSlashRedirect
: {Boolean}, default totrue
. If enabled, the trie will detect if the current path can't be matched but a handler for the path with (without) the trailing slash exists. matched.tsr will returns either a redirect path or an empty string. For example if /foo/ is requested but a route only exists for /foo, the client is redirected to /foo. For example when "/api/foo" defined and matching "/api/foo/", The result matched.tsr is "/api/foo".
let trie1 = new Trie()
let trie2 = new Trie({
ignoreCase: false,
fixedPathRedirect: false,
trailingSlashRedirect: false
})
Class Method: Trie.prototype.define(pattern)
Returns a Node instance for the pattern
, The same pattern will always return the same node.
Pattern Rule
The defined pattern can contain six types of parameters:
Syntax | Description |
---|---|
:name | named parameter |
:name(regexp) | named with regexp parameter |
:name+suffix | named parameter with suffix matching |
:name(regexp)+suffix | named with regexp parameter and suffix matching |
:name* | named with catch-all parameter |
::name | not named parameter, it is literal :name |
Named parameters are dynamic path segments. They match anything until the next '/' or the path end:
Defined: /api/:type/:ID
/api/user/123 matched: type="user", ID="123"
/api/user no match
/api/user/123/comments no match
Named with regexp parameters match anything using regexp until the next '/' or the path end:
Defined: /api/:type/:ID(^\d+$)
/api/user/123 matched: type="user", ID="123"
/api/user no match
/api/user/abc no match
/api/user/123/comments no match
Named parameters with suffix, such as Google API Design:
Defined: /api/:resource/:ID+:undelete
/api/file/123 no match
/api/file/123:undelete matched: resource="file", ID="123"
/api/file/123:undelete/comments no match
Named with regexp parameters and suffix:
Defined: /api/:resource/:ID(^\d+$)+:cancel
/api/task/123 no match
/api/task/123:cancel matched: resource="task", ID="123"
/api/task/abc:cancel no match
Named with catch-all parameters match anything until the path end, including the directory index (the '/' before the catch-all). Since they match anything until the end, catch-all parameters must always be the final path element.
Defined: /files/:filepath*
/files no match
/files/LICENSE matched: filepath="LICENSE"
/files/templates/article.html matched: filepath="templates/article.html"
The value of parameters is saved on the matched.params
. Retrieve the value of a parameter by name:
let type = matched.params['type']
let id = matched.params['ID']
Notice for regex pattern:
As mentioned above, you may use regular expressions defining node:
var node = trie.define('/abc/:name([0-9]{2})')
assert(trie.match('/abc/47').node === node)
But due to JavaScript String Escape Notation: '\d' === 'd'
, trie.define('/abc/:name(\d{2})') === trie.define('/abc/:name(d{2})')
.
trie.define
accept a string literal, not a regex literal, the \
maybe be escaped!
var node = trie.define('/abc/:name(\d{2})')
trie.match('/abc/47') // null
assert(trie.match('/abc/dd').node === node)
The same for \w
, \S
, etc.
To use backslash (\
) in regular expression you have to escape it manually:
var node = trie.define('/abc/:name(\\w{2})')
assert(trie.match('/abc/ab').node === node)
Class Method: Trie.prototype.match(path)
path
: {String}, URL pathname to match and get the definednode
Return matched
object:
node
: {Object}, The matched node ornull
.params
: {Object}, A list of named parameters, ex,match.params.id === 'abc123'
, or a empty object.fpr
: {String}, if fixedPathRedirect enabled, it may returns a redirect path, otherwise a empty string.tsr
: {String}, if trailingSlashRedirect enabled, it may returns a redirect path, otherwise a empty string.
var node = trie.define('/:type/:id([a-z0-9]{6}')
var match = trie.match('/post')
// assert(match === null)
match = trie.match('/post/abc123')
// assert(match.node === node)
// assert.deepEqual(match.params, {type: 'post', id: 'abc123'})
Class: Trie.Node
It is created by trie.define
.
Class Method: Node.prototype.handle(method, handler)
Mount handler with a method to the node.
let trie = new Trie()
trie.define('/').handle('GET', handler)
trie.define('/').handle('PUT', handler)
trie.define('/api').handle('GET', handler)
Class Method: Node.prototype.getHandler(method)
Get the handler by method from the node.
let handler = trie.match('/api').node.getHandler('GET')
Class Method: Node.prototype.getAllow()
Get the "allow" header on the node.
console.log(trie.match('/').node.getAllow()) // 'GET, PUT'
Class: Trie.Matched
It is returned by trie.match
.
class Matched {
constructor () {
// Either a Node pointer when matched or nil
this.node = null
this.params = {}
// If FixedPathRedirect enabled, it may returns a redirect path,
// otherwise a empty string.
this.fpr = ''
// If TrailingSlashRedirect enabled, it may returns a redirect path,
// otherwise a empty string.
this.tsr = ''
}
}