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

hms-protocol

v1.2.3

Published

The protocol stream that hms uses to communicate between servers and clients

Downloads

27

Readme

hms-protocol

The protocol stream that hms uses to communicate between servers and clients

npm install hms-protocol

Build Status

This is mostly only useful for hms

Usage

Simply pipe the stream to and from a source

var protocol = require('hms-protocol');
var net = require('net');

net.createServer(function(stream) {
	var p = protocol();
	stream.pipe(p).pipe(stream);

	p.on('start', function(id, cb) {
		console.log('we received a start for', id);
		cb();
	});
}).listen(10000, function() {
	var p = protocol();
	var stream = net.connect(10000);
	stream.pipe(p).pipe(stream);

	p.start('test', function(err) {
		console.log('start was received?', err);
	});
});

Send messages

The following messages are supported over the protocol

  • p.handshake(opts, cb) send a protocol handhake
  • p.ping(cb) ping to see if remote is alive
  • p.get(id, cb) get information about a service
  • p.add(id, service, cb) add a new service.
  • p.update(id, service, cb) update an existing service
  • p.remove(id, cb) remove a service
  • p.list(cb) list all services
  • p.ps(cb) get process information about all services
  • p.start(id, cb) start a service
  • p.stop(id, cb) stop a service
  • p.restart(id, cb) restart a service
  • p.sync(id, service, cb) sync service state
  • p.subscribe([id], cb) subscribe to service events. omit the id to subscribe to *
  • p.unsubscribe([id], cb) unsubscribe from service events. omit the id to unsubscribe *
  • p.stdout(id, origin, buffer) send a stdout event
  • p.stderr(id, origin, buffer) send a stderr event
  • p.spawn(id, origin, pid) send a process spawn event
  • p.exit(id, origin, code) send a process exit event
  • p.amSubscribing(id) returns true if you are subscribing to id
  • p.peerSubscribing(id) returns true if the peer is subscribing to id

The service message can contain the following

{
	start: 'node .',
	build: 'npm install',
	docks: [
		'dock-id-to-run-at'
	],
	env: {
		FOO: 'bar'
	}
}

Receive messages

Sending any of the above messages will trigger an event of the same for the receiver. I.e. if you do p.start(id, cb) it will result in p.on('start', id, cb) being triggered for the receiver

License

MIT