Composable trie based router. It's faster than traditional, linear, regular expression-matching routers, although insignficantly, and scales with the number of routes.
- works with any framework
- built for speed
- minimal dependencies
$ npm install wayfarer
const wayfarer =const router =routerrouterrouterrouter// => 'user is tobi'// => '404 not found'// => 'wildcard path is example/path'
Routers can be infinitely nested, allowing routing to be scoped per view. Matched params are passed into subrouters. Nested routes will call their parent's default handler if no path matches.
const r1 =const r2 =r2r1// => 'subrouter trix!'
Sometimes it's necessary to walk the
trie to apply transformations.
const walk =const wayfarer =const router =routerrouter// => 8// => 4
router = wayfarer(default)
Initialize a router with a default route. Doesn't ignore querystrings and hashes.
router.on(route, cb(params, [arg1, ...]))
Register a new route. The order in which routes are registered does not matter. Routes can register multiple callbacks. The callback can return values when called.
val = router(route, [arg1, ...])
Match a route and execute the corresponding callback. Alias:
Returns a values from the matched route (e.g. useful for streams). Any
additional values will be passed to the matched route.
Wayfarer is built on an internal trie structure. If you want to build a router
using this trie structure it can be accessed through
require('wayfarer/trie'). It exposes the following methods:
trie = Trie()- create a new trie
node = trie.create(route)- create a node at a path, and return a node
node = trie.match(route)- match a route on the the trie and return a node
trie.mount(path, trie)- mount a trie onto a node at route
multiple nested partials don't match
/:foo/:bar/:baz won't work. This is due
Trie.mount() overriding child
partial paths when mounted. I'll get around to fixing this at some point in the
future, but if anyone wants to contribute a patch it'd most appreciated.
Why did you build this?
Routers like react-router are complicated solutions for a simple problem. In reality all that's needed is a methodless router that can define + match paths and can mount other routers to delegate requests.
Why isn't my route matching?
Wayfarer only compares strings. Before you pass in an url you probably want to strip it of querystrings and hashes using the pathname-match module.
- sheet-router - fast, modular client-side router
- server-router - server router
- hash-match - easy
- pathname-match - strip querystrings and hashes from a url
- wayfarer-to-server -
Wrap wayfarer to provide HTTP method matching and