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

method-web-socket-expose

v1.0.64

Published

Method WebSocket. A simple wrap on top of websocket for client and server communication by serving methods in both sides in an asynchronous response.

Downloads

6

Readme

ws: a node.js websocket library

method-web-socket-expose is a simple to use ws implementation.

Installing

npm install --save method-web-socket-expose

Server defining a method

var ws = require('method-web-socket-expose');
var router = require('method-web-socket-expose').Router();
var server = new ws.start({host:"localhost", port: 8000});

router.setMethod('serverMethod', function (_return) {
	_return(["What's Up!"], "Bye");
});
server.use(router);

Client calling server method

var ws = require('method-web-socket-expose').client;
var client = ws.connect('ws://localhost:8000');

client.on('ready', function(){
  client.serverMethod("tellmeSomething").then(function(res,err){
  	console.log(arguments);
  });
});

Server executing a method on client side.

var ws = require('method-web-socket-expose');
var server = new ws.start({host:"localhost", port: 8000});

server.on('connection', function(client){
	setTimeout(function(){
		client.execute('clientMethod',["hello", "Bye"]);
	}, 3000);
});

Client defining a method

var ws = require('method-web-socket-expose').client;
var client = ws.connect('ws://localhost:8000');

client.setMethod('clientMethod', function (response) {
	console.log(response);
});

ExpressJS example

Start the web socket on http express server, in the file www

var app = require('../app');
var ws = require('method-web-socket-expose');

/**
 * Create HTTP server.
 */

var server = http.createServer(app);
/**
 * Start server listening 
 **/
ws.getServer('my-ws-server').start(server,"my-ws-server");
.....

ExpressJS example

Using the ws server in app.js

var express = require('express');
var ws = require('method-web-socket-expose');

/**
 * Create Server instance.
 *  *Without starting listen.
 **/
var wsServer = ws.start({},'my-ws-server');

/*
* EXPOSE ROUTER METHOS TO WEB SOCKET
*/
wsServer.use( require('./routes/session') );
wsServer.use( require('./routes/employ') );
wsServer.use( require('./routes/person') );
wsServer.use( require('./routes/management') );
.....

Server sending broadcast data

var ws = require('method-web-socket-expose');
var server = new ws.start({host:"localhost", port: 8000});

server.on('connection', function(client){
	client.execute('clientMethod',["hello","bye"]);
});

server.broadcast = function broadcast(data) {
  server.clients.forEach(function each(client) {
    client.send(data);
  });
};