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

client-builder

v0.0.3

Published

Tool for building http api clients

Downloads

4

Readme

Client Builder

Client builder is a tool for node that makes it easy to make clients for HTTP APIs.

Quick Setup

import {API, Endpoint} from 'client-builder'

const api = new API({
  base: 'https://api.github.com',
  qsParams: ['access-token'],
  params: {
    'access-token': 'my-access-token',
  },
  responseTransform: (httpResponse) => JSON.parse(httpResponse.body),
})

const editComment = new Endpoint(api, '/repos/:owner/:repo/issues/:number/comments', {
  method: 'GET',
  params: {
    owner: 'tal',
  }
})

const response = endpoint.performAction({
  repo: 'client-builder',
  number: '123',
})

response.then((json) => {
  console.log('first comment', json[0])
})

This is a basic way to setup your endpoints. For any method but GET all parameters other than those specified in qsParams are encoded and placed in the body of the request.

Advanced

The options passed into both Endpoint and API are merged before the rquest is made.

Both classes constructors take the options:

{
  params: {},  // string:string object
  headers: {}, // string:string object
  responseTransform: function() {}, // helper method to transform the response
  qsParams: [], // [string]
}

Params merging

For example:

const api = new API({
  base: 'https://test.com',
  qsParams: ['access-token'],
  params: {
    'access-token': 'my-access-token',
    path_param: 'path',
    to_override: 'top',
  },
  headers: {
    'User-Agent': 'client builder',
  },
})

const editComment = new Endpoint(api, '/endpoint/:path_param', {
  method: 'PATCH',
  params: {
    owner: 'tal',
  },
  headers: {
    'Accept': 'application/json+fmt',
  },
})

const response = endpoint.performAction({
  comment: 'This is a comment',
  to_override: 'overridden',
})

Will yield the following request:

HOST: https://test.com
PATH: /endpoint/path?access-token=my-access-token
HEADERS: User-Agent=client builder;Accept=application/json+fmt;
BODY:
{
  "comment": "This is a comment",
  "owner": "tal",
  "to_override": "overridden"
}

Todo

  • Easy "next page" support