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

qrouter

v5.1.1

Published

Qumram express router that handles websockets and REST

Downloads

6

Readme

Qrouter

Router middleware for express

  • Provides functionalities provides by default express router
  • Adds web socket support for your REST endpoints with no additional code
  • Automatic registration of endpoints

NPM

Installation

Install using npm:

npm install qrouter

##Usage

Initialising middleware

app.use(router.middleware({
    handler: app,
    routes:'app/components/api',
    paramAware: true,
    paramPrefix: 'tenant'
}));
  • handler : the express application
  • routes : folder to find the router controllers
  • paramAware : define if service is param aware (tenant, language etc) or not (optional field), by default param unaware
  • paramPrefix : the parameter name to use for the param awarenesses passed in api urls.

Router Controller Structure

var QmrmRouter = require('qrouter'); // include package
var PARAM_UNAWARE = false;
var router = new QmrmRouter({ // create router
	rest: '/prefix',  // REST endpoint prefix (all route will be prefixed with it)
	socket: {
		req: 'prefix.req' // socket request message prefix (all socket request message will be prefixed with it)
		resp: 'prefix.resp' // socket response message prefix (all socket response message will be prefixed with it)
	}
});

router.options(PARAM_UNAWARE, '/', cors());
router.get(PARAM_UNAWARE, 'status.get', 'status.resp', '/', cors(), function (req, res) {  
	// param unaware endpoint in param aware application
	// first parameter defines it is param unaware (optional argument)
	// second parameter is socket request message
	// third parameter is socket response message
	// fourth paramter is route
	// can have any number of express middlewares after this
});

router.get('status.get', 'status.resp', '/', cors(), function (req, res) {  
	// param aware endpoint in param aware application
});