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

http-js

v0.0.1

Published

A HTTP utilities library for client-side applications.

Downloads

4

Readme

http.js

Build Status Coverage Status

http.js is a Promises/A+ compliant HTTP request library for client-side applications.

Getting Started

To get started, you should first get yourself a copy of http.js:

via bower

$ bower install --save http-js

via npm

$ npm install --save-dev http-js

via github releases

Alternatively, if you don't like package managers, you can get yourself the latest version from GitHub Releases.

Browser Support

Courtesy of the test suite that's run on BrowserStack, the officially supported browsers are as follows:

  • Chrome: Latest stable version.
  • Firefox: Latest stable version.
  • Opera: Latest stable version.
  • Internet Explorer: 8, 9, 10, 11.

Usage

A simple request

Supported shorthand methods are get, post, put, delete and patch.

Http.get({ url: "/foo" }).then(function (response) {
    // logs something like:
    // {
    //   statusCode: 200,
    //   headers: {
    //     "Content-Type": "application/json;encoding=UTF-8"
    //   },
    //   body: {
    //     foo: "bar"
    //   }
    // }
    console.log(response);
})["catch"](function (error) {
    // See section titled `Errors` for further information.
    console.error(error);
});

Query parameters

// Makes a request to `/foo?bar=1&bar=2&baz=3`
Http.get({
    url: "/foo",
    query: {
        bar: [1, 2],
        baz: 3
    }
});

Response types

By default, json is used. You can select one of json, text and xml by using the responseType option:

Http.get({
    url: "/foo",
    responseType: "xml"
});

Request types

By default, form-urlencoded is used. You can select one of form-urlencoded, text and json by using the contentType option:

Http.post({
    url: "/foo",
    contentType: "json",
    body: {
        foo: "bar"
    }
});

Cross Origin Resource Sharing, a.k.a. CORS, with cookies

NOTE: Only works if the browser supports CORS.

Http.get({
    url: "/foo",
    crossOrigin: "use-credentials"
});

Custom Headers

Http.get({
    url: "/foo",
    headers: {
        "X-My-Header": "bar"
    }
});

Changing Promises Implementation

By default, http.js uses ES6 promises. You can either use them with the polyfill, or plug your favorite Promises/A+ implementation in:

// Kris Kowal's Q
Http.PromiseImplementation = Q;

// RSVP
Http.PromiseImplementation = RSVP.Promise;

Errors

http.js rejects its requests with three kind of errors:

HttpError

This error is triggered if the server responds with a status code other than 2xx.

Properties
  • type (string): This is always set to HttpError.
  • message (string): This is something like GET <url> failed with status 404.
  • statusCode (number): The response status code the server returned.
  • headers (object): The response headers the server returned.
  • body: (any): The response body the server returned.

ResponseError

This error is triggered if the response from the server could not be successfully processed.

Properties
  • type (string): This is always set to ResponseError.
  • message (string): This is something like GET <url> failed with status 404.
  • statusCode (number): The response status code the server returned.
  • headers (object): The response headers the server returned.
  • body: (any): The response body the server returned.

NetworkError

This error is triggered if no response is available. Possible reasons:

  • Connection to server could not be established.
  • Connection timed out.
  • Server did not respond.
  • Server doesn't support CORS for this endpoint.
Properties
  • type (string): This is always set to NetworkError.
  • message (string): This is something like GET <url> failed with status due to a network error (missing CORS headers?).

Contributing

Contributions are most welcome! If you're having problems and don't know why, search the issues to see if someone's had the same issue. If not, file a new issue so we can solve it together and leave the solution visible to others facing the same problem as well. If you find bugs, file an issue, preferably with good reproduction steps. If you want to be totally awesome, you can make a PR to go with your issue, containing a new test case that fails currently!

Development

Development is pretty straightforward, it's all JS and the standard node stuff works:

To install dependencies:

$ npm install

To run the tests:

$ npm test

Then just make your awesome feature and a PR for it. Don't forget to file an issue first, or start with an empty PR so others can see what you're doing and discuss it so there's a a minimal amount of wasted effort.

Do note that the test coverage is currently a whopping 100%. Let's keep it that way! Remember: if it's not in the requirements specification (i.e. the tests), it's not needed, and thus unnecessary bloat.