machinepack-http

machinepack-http

Send HTTP requests, scrape webpages, and stream data in your JavaScript/Node.js/Sails.js app with a simple, jQuery.get()-like interface for sending HTTP requests and processing server responses.

mp-http is focused on immediate productivity with everyday cloud API interactions you're likely to encounter in web, mobile, and IoT apps. Think of it as a simple, practical utility for simple, everyday cloud API interactions and integration tasks: scenarios where you don't need the flexibility of custom multipart POSTs or support for the HAR spec.

This package is maintained by the Sails.js core team. Its primary goal is to provide robust, easy-to-use access to the HTTP protocol from Sails.js and Node.js. Out of the box, it allows for negotiating errors from request failure (i.e. if the user is offline or the server is down) vs. errors from non-2xx status codes (e.g. deliberate server errors), as well as low-level streaming access to the HTTP response. However this package is not designed to be a replacement for request. (In fact, it's just a higher-level wrapper around the request module!)

Installation  

To install this package, run:

$ npm install machinepack-http --save

Then require it from the actions or helpers in your Sails app, a command-line script, or any other Node.js module.

Usage

For the latest usage, version information, and test status of this module, see http://node-machine.org/machinepack-http. The generated manpages for each machine contain a complete reference of all expected inputs, possible exit states, and example return values. If you need more help, or find a bug, jump into our chat room or leave a message in the project newsgroup.

Questions?

As a machinepack, this package implements a set of declarative interfaces, conventions, and best-practices for integrating with other software. This loyal adherence to the specification enables the (re)use of built-in generic test suites, standardized documentation, reasonable expectations around the API for your users, and overall, a more pleasant development experience for everyone.

Documentation pages for the machines contained in this module (as well as all other NPM-hosted machines for Node.js) are automatically generated and kept up-to-date on the public registry. Learn more at http://node-machine.org/implementing/FAQ.

See the documentation for actions2 for Node.js/Sails.js, or check out other recommended support options.

Contributing    

Please observe the guidelines and conventions laid out in the Sails project contribution guide when opening issues or submitting pull requests.

Bugs  

To report a bug, click here.

License

This core package is available under the MIT license.

As for the Sails.js framework and Node Machine Project? They're free and open-source under the MIT License too.

MIT © 2015-2017 Mike McNeil, Scott Gress, The Sails Co.