wayfarer

wayfarer

A simple trie based router built for minimalism and speed. Works best with Browserify.

Installation

npm install wayfarer

Overview

var router = require('wayfarer');

// Register routes.

router({qs: false})
  .default('/404')
  .route('/', function() {console.log('/')})
  .route('/home', function() {console.log('/home')})
  .route('/404', function() {console.log('/404')})
  .route('/:user', function() {console.log('/user')})
  .match('/tobi');
  // => '/user'

API

wayfarer(opts)

Initialize wayfarer with options. Setting qs to false stops wayfarer from triggering on changes to the querystring.

var router = wayfarer({qs: false});

.route(path, cb)

Register a new path. Partial paths are supported through the /: operator. Wayfarer uses a trie to match routes, so the order in which routes are registered does not matter.

router.route('/', function() {console.log('do stuff')});
router.route('/:user', function() {console.log('do user stuff')});

.default(defaultPath)

Sets a default path to match. This is particularly useful for setting 404 pages.

router.default('/404');
router.route('/404', function() {console.log('sunglasses not found')});

.match(path)

Match a path against the saved paths in the router. If a match is found the registered callback will be executed.

router.match('/tobi');
// => 'do user stuff'

License

MIT