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 🙏

© 2025 – Pkg Stats / Ryan Hefner

superclient

v1.4.3

Published

Create a fluent interface to an API

Downloads

9

Readme

superclient

using it is pretty easy:

configure routing

    var superclient = require('superclient');
    
    // create a constructor by configuring the routing
    var Client = superclient(function() {
        // adds a basic route '/test'
        this.route('test');
        
        // adds a resource route '/images' and '/images/:id'
        this.resource('images');
        
        // add another resource route '/users' and '/users/:id'
        this.resource('users', function() {
            // this adds a sub-route `/users/:id/profile`
            this.route('profile');
        });
    });

Client is a constructor that takes an optional prefix and a function which is called for every request. This is how you can delegate to supertest or superagent.

    // prefix all URLs with 'api'
    var api = new Client('api', function performRequest(verb, url) {
        return superagent[verb](url); // superagent(express)[verb](url)
    });

Now this api object is a fluent interface to the routing that was configured previously:

    // remember we specified the prefix 'api'
    api.foo // undefined
    api.test // a 'handler' which has HTTP verbs on it
    api.test.get() // superagent.get(/api/test)
    
    // the call goes through to super[agent|test] like normal
    api.users.post().send({ name: 'new user' }); // superagent.post(/api/users)
    
    api.users(123).put() // superagent.put(/users/123)
    api.users(123).profile.get() // superagent.get(/users/123/profile)

The configuration step can be done separately and even exported as it's own package - since the request handling is provided late, you can use it as a real API client as well as for testing said API itself. Also since the prefix is determined outside of the routing structure this can come in handy (service location, etc.)

things to add:

it would be interesting to support arbitrarily nested routing, including subresources i.e. /foo/:foo_id/someRoute/bar/:bar_id

it might also be ineresting to take a URL as a 'step' to build from, so if you get a Created response with a Location header, something like:

    api.users.post({ /* ... */ }).then(function() {
        var location = '/users/9000'; // assume that's the header
        var user = api.users(/* undefined id */).url(location) // 'set' the url up to this point
        user.profile.get() // GET /users/9000/profile
    })