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

minimal-rpc

v0.0.1

Published

Minimal RPC streams for sending the smallest amount of data across the wire.

Downloads

5

Readme

Minimal RPC

Minimal RPC streams for sending the smallest amount of data across the wire.

Browser Support

Build Status

API


  var RPC = require('minimal-rpc'),
      stream1 = RPC(),
      stream2 = RPC();

  stream1.pipe(stream2).pipe(stream1);

  stream1.registerRPC(new Buffer('0'), function (data) {
    console.log(data.toString('utf-8')); // Pong
  });

  stream2.registerRPC(new Buffer('1'), function (data) {
    console.log(data.toString('utf-8')); // Ping
    stream2.callRPC(new Buffer('0'), new Buffer('Pong'));
  });

  stream1.callRPC(new Buffer('1'), new Buffer('Ping'));

MinimalRPC()

  • Return Duplex RPC Stream

instance.registerRPC(id, fn)

  • id Buffer
  • fn Function

The id is stored to distinguish the RPC calls from the other side. The smaller the id, the smaller the framing that needs to be sent by the caller.

instance.callRPC(id, data)

  • id Buffer
  • data Buffer

The id is sent down the wire to distinguish the stream on the other side. The smaller the id, the smaller the framing sent. If you want to send objects across you can use new Buffer(JSON.stringify(Object)). This allows users to pack their data in the most efficient way that they can.

Errors

An instance will emit an error event if the called RPC is not registered. You can listen for errors with instance.on('error', function (err) {});. If you are using MinimalRPC in an untrusted environment and you get an RPC not found error it is probably a good idea to disconnect.

License

(The MIT License)

Copyright (c) 2014 RGBboy <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.