wayfarer

wayfarer

Composable trie based router. It is faster than traditional, linear, regular expression-matching routers, although insignficantly, and scales with the number of routes.

Installation

$ npm install wayfarer

Usage

const wayfarer = require('wayfarer')

const router = wayfarer('/404')

router.on('/', () => console.log('/'))
router.on('/404', () => console.log('404 not found'))
router.on('/:user', params => console.log('user is %s', params.user))

router('/tobi')
// => 'user is tobi'

router('/uh/oh')
// => '404 not found'

Subrouting

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 = wayfarer()
const r2 = wayfarer()

r1.on('/:parent', r2)
r2.on('/child', () => console.log('subrouter trix!'))

r1('/dada/child')
// => 'subrouter trix!'

API

router = wayfarer(default)

Initialize a router with a default route. Doesn't ignore querystrings and hashes.

router.on(route, cb(params))

Register a new route. The order in which routes are registered does not matter. Routes can register multiple callbacks. See routington.define() for all route options.

router(route)

Match a route and execute the corresponding callback. Alias: router.emit().

Internals

Warning: these methods are considered internal and should only be used when extending wayfarer.

• router._default(params): Trigger the default route. Useful to propagate error states.
• routes = router._routes: Expose the mounted routes.
• subrouters = router._subrouters: Expose the mounted subrouters.

FAQ

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.

See Also

• hash-match - easy window.location.hash matching
• pathname-match - strip querystrings and hashes from a url
• wayfarer-to-server - Wrap wayfarer to provide HTTP method matching and req, res delegation

License

MIT

Changelog

5.0.1 - 2015-08-24

Fixed

• [3e0317d] nesting: add fallback for 0.12