https://github.com/kyleamathews/superagent-bluebird-promise

Add promise support to superagent using Bluebird
https://github.com/kyleamathews/superagent-bluebird-promise

Last synced: 11 days ago
JSON representation

Add promise support to superagent using Bluebird

• Host: GitHub
• URL: https://github.com/kyleamathews/superagent-bluebird-promise
• Owner: KyleAMathews
• License: mit
• Created: 2014-08-07T22:43:34.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2017-05-31T21:36:40.000Z (over 7 years ago)
• Last Synced: 2024-10-20T09:13:24.439Z (24 days ago)
• Language: CoffeeScript
• Homepage:
• Size: 74.2 KB
• Stars: 182
• Watchers: 8
• Forks: 37
• Open Issues: 32
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.MD
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://img.shields.io/travis/KyleAMathews/superagent-bluebird-promise/master.svg?style=flat-square)](http://travis-ci.org/KyleAMathews/superagent-bluebird-promise)

superagent-bluebird-promise

===========================

Add promise support to

[Superagent](http://visionmedia.github.io/superagent/) using

[Bluebird](https://github.com/petkaantonov/bluebird).

## Install

`npm install superagent-bluebird-promise`

## Usage

Simply require this package instead of `superagent`. Then you can call `.then()` or `.catch()` instead of `.end()` to get a promise for your requests.

```javascript

var request = require('superagent-bluebird-promise');

// .then()

request.get('/an-endpoint')

  .then(function(res) {

    console.log(res);

  }, function(error) {

    console.log(error);

  });

// .catch()

request.get('/an-endpoint')

  .catch(function(error) {

    console.log(error);

  });

```

To generate a promise without registering any callbacks (e.g. when returning a promise from within a library), call `.promise()` instead.

```javascript

request.get('/an-endpoint').promise()

```

In order to use any of Bluebird's various promise methods, make sure you call `.then()` or `.promise()` first.

An error is thrown for all HTTP errors and responses that have a response code of 400 or above.

The `error` parameter always has a key `error` and for 4xx and 5xx responses, will also have a `status` and `res` key.

## Cancelling requests

You can [abort the request](http://visionmedia.github.io/superagent/#aborting-requests) by [cancelling the promise](https://github.com/petkaantonov/bluebird/blob/master/API.md#cancelerror-reason---promise):

```js

promise.cancel();

```

This is only possible because  we have configured bluebird to be [cancellable](http://bluebirdjs.com/docs/api/promise.config.html) by default.