SuperAgent

SuperAgent is a small progressive client-side HTTP request library, and Node.js module with the same API, sporting many high-level HTTP client features. View the docs.

Installation

node:

1

$ npm install superagent

component:

1

$ component install visionmedia/superagent

Works with browserify and should work with webpack

1
2
3
4
5
6
7
8

request
  .post('/api/pet')
  .send({ name: 'Manny', species: 'cat' })
  .set('X-API-Key', 'foobar')
  .set('Accept', 'application/json')
  .end(function(err, res){
    // Calling the end function will send the request
  });

Supported browsers

Tested browsers:

• Latest Android
• Latest Firefox
• Latest Chrome
• IE9 through latest
• Latest iPhone
• Latest Safari

Even though IE9 is supported, a polyfill window.btoa is needed to use basic auth.

Plugins

Superagent is easily extended via plugins.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

var nocache = require('superagent-no-cache');
var request = require('superagent');
var prefix = require('superagent-prefix')('/static');

request
.get('/some-url')
.use(prefix) // Prefixes *only* this request
.use(nocache) // Prevents caching of *only* this request
.end(function(err, res){
    // Do something
});

Existing plugins:

• superagent-no-cache - prevents caching by including Cache-Control header
• superagent-prefix - prefixes absolute URLs (useful in test environment)
• superagent-mock - simulate HTTP calls by returning data fixtures based on the requested URL
• superagent-mocker — simulate REST API
• superagent-cache - superagent with built-in, flexible caching
• superagent-jsonapify - A lightweight json-api client addon for superagent
• superagent-serializer - Converts server payload into different cases

Please prefix your plugin with superagent-* so that it can easily be found by others.

For superagent extensions such as couchdb and oauth visit the wiki.

Running node tests

Install dependencies:

1

$ npm install

Run em!

1

$ make test

Running browser tests

Install dependencies:

1

$ npm install

Start the test runner:

1

$ make test-browser-local

Visit http://localhost:4000/__zuul in your browser.

Edit tests and refresh your browser. You do not have to restart the test runner.

License

MIT