edmond

Simple JavaScript router for web applications.

Edmond

Edmond is simple JavaScript router for web applications. Although Edmond was originally designed for use in the browser, it can also be used with Node.js.

  • Edmond has no dependencies
  • AMD compatible, you can load it via RequireJS
  • Ultra lightweight, under 1 KB
  • Fully documented
  1. Add a new route

    edmond.addRoute('/users/:id', function(request) {
     
      // Do something... 
     
    });
  2. Listen to the ‘error’ event

    edmond.on('error', function(message) {
     
      // Do something... 
     
    });
  3. Dispatch the route

    edmond.dispatchRoute('/users/123');

    Please see the Tips section for more information about implementing HTML5 history.

Releases are available for download from GitHub.

VersionDescriptionSizeAction
edmond.jsuncompressed, with comments1 KBDownload
edmond.min.jscompressed, without comments1 KBDownload

Tips

  1. First of all, we need to add a new event listener

    window.addEventListener('popState', function() {
      edmond.dispatchRoute(window.location.pathname);
    });
  2. Secondly, add a new event listener to the dispatch event

    edmond.on('dispatch', function(path) {
      history.pushState({}, null, path);
    });

Documentation

Methods

Objects

In route you can use placeholders (for instance :username) which are then available as request.params.

The callback fn gets two arguments request and next where request is a request object (see request for more information) and the second argument next allows you to move to the next callback (if defined).

Example

edmond.addRoute('/users/:username', function(requestnext) {
 
  alert('Hello ' + request.username + '!');
 
});

Example

edmond.dispatchRoute('/users/123/delete');

Events

  • error
  • dispatch

Example

edmond.on('error', function(message) {
 
  // Do something... 
 
});

{
  params: {
    ...
  },
  query: {
    ...
  },
  path: ...
  hash: ...
}

Example

{
  params: {
    id: 123,
    action: 'delete'
  },
  query: {
    filter: 'recent'
  },
  path: '/users/123/delete?filter=recent#top'
  hash: '#top',
  route: '/users/:id/:action'
}

Running Tests

$ npm tests/

License

(The MIT License)

Copyright (c) 2011 František Hába <hello@frantisekhaba.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.