ruta3

Route matcher devised for shared rendering JavaScript applications

  • ruta3

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
ruta3
2.0.18 years ago9 years agoMinified + gzip package size for ruta3 in KB

Readme

ruta3
Route matcher devised for shared rendering JavaScript applications
Install
npm install --save ruta3
Sample Usage
Get a router instance
var ruta3 = require('ruta3');
var router = ruta3();

Add some routes
router.addRoute('/articles', getArticles);
router.addRoute('/articles/:slug', getArticleBySlug);
router.addRoute('/articles/search/*', searchForArticles);

Find a match
router.match('/articles');

You'll get null back if no route matches the provided URL. Otherwise, the route match will provide all the useful information you need inside an object.
Key | Description ------------------|--------------------------------------------------------------------------------------- action | The action passed to addRoute as a second argument. Using a function is recommended next | Fall through to the next route, or null if no other routes match route | The route passed to addRoute as the first argument params | An object containing the values for named parameters in the route splats | An object filled with the values for wildcard parameters
License
MIT
(originally derived from routes1, which is no longer maintained)