bluereq v2.1.12

bluereq

simple HTTP requests for promises lovers just wrapping request with bluebird. Forked from qreq

Summary

• Installation
• How-to
  • the simple way
  • the more configurable way
  • debug
• Alternatives

Installation

npm install bluereq

How-to

var breq = require('bluereq')

the simple way

• GET / HEAD / DELETE

breq.get(url) // or breq.head(url) or breq.delete(url)
.then(function (res) { // do your magic here } )
.catch(function (err) { // handle error } )

• POST / PUT

breq.post(url, data) // or breq.put(url, data)
.then(function (res) { // do your magic here } )
.catch(function (err) { // handle error } )

Here, data is assumed to be an object to be posted/put as JSON. If it isn't the case use the more configurable way

the more configurable way

Take advantage of request configurability to customize your request

• GET / POST / PUT / HEAD / DELETE

breq.get(config) // or breq.post(config) or breq.put(config) or breq.head(config) or breq.delete(config)
.then(function (res) { // do your magic here } )
.catch(function (err) { // handle error } )

where config is an object with at least a url set

Example:

var config = {
  url: 'https://inventaire.io/api/tests/public',
  body: { love: 'from bluereq'},
  headers: {
    'content-type': 'application/x-www-form-urlencoded',
    'cookie': 'bimbamboumcookie=wunderbar'
  }
}
breq.post(config)

See request documentation for more options

debug

As it is using request under the hood, you can get debug it the same way:

export NODE_DEBUG=request ; node script.js

Alternatives

I started this lib as a simple fork of qreq, not seeing that a lot was already happening to wrap request and bluebird together, especially request-promise seems interesting, (while slightly more bloted ;) )