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-socket-router

v1.6.8

Published

1.6.8

Downloads

310

Readme

Web Socket Router Build StatusMaintainabilitycodecov

Overview

This is implementation of websocket to provide a clear way to connect to and from a websocket server. Providing tools such, methods, routes, and filters.

  • Creating a new instance of the Web Socket Router

By creating a new instance of the web socket router and passing to the constructor the built-in-web-socket-instance, you are able to start subscribing and sending messages.

var webSocketRouterInstance = new WebSocketRouter(new WebSocket('ws://domain:port')[, context]);
  • Sending messages

Using the message object's builder, you cand send messages to/from the server.

webSocketRouterInstance.message({
	route: '/artist',
	action: webSocketRouterInstance.action.CREATE,
	data: {
		id: 0,
		name: 'Pearl Jam'
	}
});
  • Listening to messages

This way you can define a listener for the route '/artist' with action CREATE.

webSocketRouterInstance.create('/artist', [
	function (artist) {
		//Save Artist Data
	},
	artistController.printSaveMessage
);
  • Routes Interceptors

You can also intercept messages to do error checking.

webSocketRouterInstance.intercept('*', function (artist) {
	if (!artits.id) {
    	throw ('No artist id defined.')
    }
});
webSocketRouterInstance.intercept('*', [
	userController.tokenValidation,
	userController.userHasPermission
]);
webSocketRouterInstance.intercept('/artist/delete', [
	artistController.artistExists,
	artistController.userHasPermissionOnResource
]);
  • Defining filters

This way you can define a listener for the route '/artist' with action CREATE filtering by the name Pearl Jam. Filters will apply to any first-child key of the data object.

webSocketRouterInstance.create('/artist', function (artist) {
	//Save Artist Data
}).filter ({
	name: 'Pearl Jam'
});
  • Pre and post message Events This Way you can define an event before sending any route containing '/artist'.
webSocketRouterInstance.beforeSend('/artist', function (artist) {
	artist.name = artist.name.replace (/ /g, '_');
});

And post send events.

webSocketRouterInstance.afterSend('/artist', function (artist) {
	delete ArtistTempData[artist.name];
});
  • Binding a different context for the listener. Even when you can defined a default context on the Web Socket Constructor, you can also define a custom execution context for the function.
webSocketRouterInstance.on('/artist/create', artistController.create).bind(artistController);

The message-builder object.

Empty message

webSocketRouterInstance.message({});

Empty data to artist on default Action

webSocketRouterInstance.message({
	route: '/artist'
});

Custom data to artist with DELETE action

webSocketRouterInstance.message({
	route: '/artist',
	action: webSocketRouterInstance.action.DELETE
});

Custom data to artist with custom action

webSocketRouterInstance.message({
	route: '/artist',
	action: 'myCustomActionName'
});

Listener Object

  • The message-builder object.

Empty data to artist on default Action - Listener

webSocketRouterInstance.on('/artist', artistController.list);

Custom data to artist with DELETE action - Listener (Delete action its predefined and has a .delete method).

webSocketRouterInstance.delete('/artist', artistController.delete);

Custom data to artist with custom action - Listener (Custom actions needs to use the .on method and specify the action name).

webSocketRouterInstance.delete('/artist', artistController.delete).action('myCustomAction');