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

rpcinterface

v0.2.0

Published

Library that facilitates an RPC interface in a webapp or node app

Downloads

7

Readme

rpcinterface

Build a rpc interface in your webapp or node app. Requires jQuery for promises on the web (via browserify).

Usage (with browserify/node)

var rpc = require('rpcinterface');

RPCInterface Methods

rpc = new RPCInterface()

Creates a new RPCInterface instance. Should be done at application start up.

rpc.addMethod(name, params, handler)

rpc.addMethod(name, handler)

rpc.addMethod(name, options)

Adds a new handler for method name. options should be an object that has handler and params keys. handler is a callback that is called with (parameters, deferred) when a new call is made for this method name. If params are not defined then no parameter checking is done.

params should be a hash like this example:

{
    email: {type: 'string', optional: false},
    password: {type: 'string', optional: false},
    name: {type: 'string', optional: false},
    phone: {type: 'number', optional: true}
}

If params is null (rather than an object or undefined) then the parameters object sent to the handler will be an empty object, guaranteed. Normally the passed object is validated but passed through as originally sent. This could cause issues if you're expecting an empty object since your method accepts no parameters but the caller sent extraneous parameters.

rpc.removeMethod(name)

Removes the handler for method name.

rpc.setPreProcessor(func)

Sets the pre-processor, which is called before the handler but after the request is validated. The func is sent (method, params, dfd). method is the string method name being called and params is the parameters object sent by the caller.

rpc.call(method[, params])

Calls a method added by addMethod and sends along the passed params. Returns a deferred. Throws if params are invalid/missing for the method being called or if the method wasn't added. params can also be an array where the order of the values is based on the defined order when addMethod was called.