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

skyrpcclient

v1.0.2

Published

Remotely resolve and call a SkyAPI-registered JSON-RPC endpoint.

Downloads

5

Readme

skyrpcclient

A Node.js client for making SkyDNS-backed JSON-RPC remote calls. It's a combination of node-srvclient and node-rpclib.

Usage

var SkyRPCClient = require('skyrpcclient');

var authClient = new SkyRPCClient('auth-api.services.example');

var params = {username: 'test', password: 'password'};
authClient.call('Users.Login', params, function(err, res) {
  // ... handle result or error here
});

SkyRPCClient Methods

client = new SkyRPCClient(hostname)

hostname is the name of the remote RPC endpoint. The hostname will be resolved using a SRV lookup and a target will be randomly chosen each time call is invoked.

client.resolve(callback)

resolves the client's hostname and calls callback with a list of targets. This is just an alias for getRandomTargets from node-srvclient.

call = client.call(name, params, callback)

calls a remote method name and passes params. callback is called with an error and result. returns an instance of RPCClientResult which can be treated like a promise.

Note By default, call will use the last DNS answer if a subsequent lookup fails. To disable this functionality, set client.fallbackOnDNSError to false.

client.preprocess

A function that can be used to filter/alter the results that get resolved as part of call. This function gets an array of SRVTarget's and expects a return of an array of SRVTarget's.

client.fallbackOnDNSError

By default if a DNS lookup fails, it falls back to the last received dns lookup. Set fallbackOnDNSError to false if you do not want this behavior.

client.retryOnError

By default if a call fails because of an HTTP or JSON error, it will not be retried. Set retryOnError to true to try the next available server on HTTP and JSON errors. Valid RPC responses, even if they're an error, will NOT be retried in either case.

SkyRPCClient.setHostnameHandler(hostname, callback)

overrides any clients created for hostname to call callback instead of making a network call. This is really only useful for testing. callback is called with name, params, callback and directly maps to the args sent to call.

SkyRPCClient.setDNSServers(servers)

Set the DNS servers to use for resolution. Identical to dns.setServers

RPCClientResult Methods

See RPCClientResult Methods