superagent-promise

by lightsofapollo

lightsofapollo / superagent-promise

Simple/dumb promise wrapper for superagent

125 Stars 28 Forks Last release: Not found MIT License 43 Commits 7 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Build Status

superagent-promise

Simple/dumb promise wrapper for superagent. You must depend on

superagent
and your favorite Promise library directly.

Usage

var Promise = this.Promise || require('promise');
var agent = require('superagent-promise')(require('superagent'), Promise);

// method, url form with end agent('GET', 'http://google.com') .end() .then(function onResult(res) { // do stuff }, function onError(err) { //err.response has the response from the server });

// method, url form with then agent('GET', 'http://google.com') .then(function onResult(res) { // do stuff });

// helper functions: options, head, get, post, put, patch, del agent.put('http://myxfoo', 'data') .end() .then(function(res) { // do stuff` });

// helper functions: options, head, get, post, put, patch, del agent.put('http://myxfoo', 'data'). .then(function(res) { // do stuff });

Mocking

Now superagent-promise can be mocked using

superagent-mock
. For the complete example see
test/mock.spec.js
and
test/mock.config.js
.
var SUCCESS_BODY = 'Yay! Mocked :)';
var mockedRequest = require('superagent');
var mocks = require('./mock.config')('localhost', SUCCESS_BODY);
require('superagent-mock')(mockedRequest, mocks);
var request = require('../index')(mockedRequest, Promise);

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.