npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

web-router

v1.2.1

Published

Simple client-side router module with middlewares, route groups and more.

Downloads

22

Readme

Install web-router with npm

Build Status

npm install --save web-router

Without browserify

<script src="/path/to/web-router.js"></script>

Usage

To setup web-router all you need to do is to reqiure the module with browserify, define your routes and then run the Route.init().

var Route = require('web-router');

Route.set('/hello/:variable', function(variable){
  console.log('hello', variable);
});

Route.group({
  'path/to/something': function(){},
  'path/to/something/else': function(){},
});

Route.init();

Route groups

Is a powerful way to structure your routes, and gives you the ability to prefix groups of routes.

// function structure
// prefix (optional): prefix is added to the routes in the group
// middleware (optional):
// routes: is a object where the object key defines the route and the related function is the callback
Route.group(prefix, middleware, routes);

// example
Route.group('admin', Auth.admin, {
  'users': UserController.list,
  'user/:id': UserController.show,
  'user/:id/delete': function(){
     // delete user
  }
});

Optional variables

If you need a variable in a route to be optional, you can do this by adding a ? at the end

Route.set('user/:id?', UserController.index);

Route parameters

If you have a url with params example.com?key=value. You can access those through the the Route.data.

// example url: www.example.com?key=value
Route.data.key // returns value

Middlewares

Middlewares are used when you want some logic to run before the callback is triggered. If the middleware returns true the callback will run as it normally would. If it returns false the route callback will not be triggered.

// Middleware example
// If you want to check if a user is logged in before the route is available
Route.set('/admin', Auth.check, function(){
  // triggers if Auth.check() returns true
});

Change route

web-router adds an event listener to all <a href="/hello/world"></a> to avoid page refreshes and instead triggers the Route.change('/hello/world').

Define 404 error

If you want to, you can rewrite the Route.notFound() to what ever you want.

// defined function which is triggered when route isn't found
Route.notFound = function(){
  // do something
};

Run unit test

npm test