bees-request v1.1.6

bees-request

A promise based simple abortable http client for node and browsers. bees-request uses the http or https modules on node and the XMLHttpRequest on browsers and React Native.

Installation

NPM:

npm install bees-request

CDN:

<script src="https://unpkg.com/bees-request/umd/bees-request.min.js"></script>

Usage

beesRequest.fetch(url[, options][, callback])
beesRequest.fetch(options)

options object has the following proprties:

• url: the url for the request. If the url is specified as a fetch argument it overwrites the value in the options object if present
• method: the method for the request. Default: GET
• data: optional data to be appended to the querystring (GET) or sent in the request body (POST)
• headers: optional key/value to be added to the request HTTP headers
• timeout: optional timeout for the request (in milliseconds)
• callback: an optional function to be called when the request is sent. If the callback is specified as a fetch argument it overwrites the value in the options object

Basic GET request:

beesRequest.fetch('http://example.com/api')
  .then(function(response) {
    // response is an instance of beesResponse object
    // it has the following methods:
    // response.json() returns a json object 
    // response.text() returns the plain text object
    // response.toString() alias to .text()
    console.log(response.text())
  })
  .catch(function(error) {
    // error is an instance of beesError
    // it has the following properties:
    // error.message
    // error.code
    // error.isAborted - an error is raised when the request is aborted
    console.log(error.message);
  });

POST Request with data:

  
beesRequest.fetch({
  url: 'http://example.com/api',
  method: 'POST', 
  data: { 
    id: 1234
  }
})
  .then(function(response) {
    console.log(response.text())
  })
  .catch(function(error) {
    console.error(error.message)
  });

Abort example:

var request = null;

beesRequest.fetch({
  url: 'http://example.com/api',
  callback: function(req) {
    request = req
  }
})
  .then(function(response) {
      console.log(response.text())
  })
  .catch(function(error) {
    if(error.isAborted) {
      // the request has been aborted
    } else {
      console.error(error.message)
    }
  });

request.abort();

Aliases:

beesRequest.get(url[, options][, callback]) // equivalent to fetch(url, options, callback) with options.method = 'GET'
beesRequest.get(options) // equivalent to fetch(url, options, callback) with options.method = 'GET'

beesRequest.post(url[, options][, callback]) // equivalent to fetch(url, options, callback) with options.method = 'POST'
beesRequest.post(options) // equivalent to fetch(url, options, callback) with options.method = 'POST'