wayfarer

wayfarer

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

Installation

$ npm i --save wayfarer

Overview

/**
 * Initialize wayfarer.
 */

var wayfarer = require('wayfarer');
var router = wayfarer();

/**
 * Register routes.
 */

router
  .default('/404')
  .path('/', function() {console.log('/')})
  .path('/home', function() {console.log('/home')})
  .path('/404', function() {console.log('/404')})
  .path('/:user', function() {console.log('/user')});

/**
 * Match a route.
 */

router.match('/tobi')
// => '/user'

API

.path()

// Register a new path. Takes a {String} pathName that calls a
// {Function} callback. 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.path('/', function() {console.log('do stuff')});
router.path('/:user', function() {console.log('do user stuff')});

.default()

// Set a {String} pathName as the default path to match. This is particularly
// useful for setting 404 pages.

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

.match()

// Match a {String} 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 © Yoshua Wuyts