hurricane v0.0.0

hurricane

HTTP client library for Node.js and the browser, with support for multiple backends.

Features

• Supports multiple backends - superagent, fetch... - you decide
• Reusable middlewares - you want a custom logger? Custom query parser? Yes, you can!
• Universal - make HTTP requests in Node and the browser with the same API
• Custom backends - you want to use your own HTTP backend? No problems!
• Easy to use - you'll be up and running in less than 5 minutes
• Familiar API - regardless what's the previous HTTP client you've used
• Promise & callback-style API

Installation

$ npm install hurricane --save

hurricane depends on ES 2015 Promises. If you are using the library in an environment that doesn't support them, you must introduce a polyfill.

Quick Introduction

TBD

Documentation

TBD

Adapters

hurricane currently supports the following adapters:

• isomorphic-fetch - Isomorphic WHATWG Fetch API, for Node & Browserify
• superagent - Ajax with less suck - (and node.js HTTP client to match)
• axios - Promise based HTTP client for the browser and node.js

You can also write your own adapter very easily. Follow the documentation.

PRs for adding support for new adapters will be highly appreciated! There is only one requirement - the adapter should work both in Node.js and in browser environments.

If the adapter that you want to contribute works only in Node.js or only in the browser, consider making it a plugin. We'll be happy to help!

Plugins

TBD

Contributing

Bug reports and pull requests are welcome on GitHub. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Credits

hurricane is heavily influenced by Faraday. If you are a Ruby engineer, we highly recommend to check it out.

When we designed the API, we wanted to make it feel as close to:

• superagent
• request
• axios

Thanks to their authors and contributors for the amazing work!

License

 _________________
< The MIT License >
 -----------------
        \   ^__^
         \  (oo)\_______
            (__)\       )\/\
                ||----w |
                ||     ||