SuperAgent

Ajax for Node.js and browsers (JS HTTP client)

visionmedia/superagentvisionmedia.github.io/superagent/superagent

README

superagent

build status code coverage code style styled with prettier made with lass license

Small progressive client-side HTTP request library, and Node.js module with the same API, supporting many high-level HTTP client features



Table of Contents


Install
Usage
  Node
  Browser
Supported Platforms
  Required Browser Features
Plugins
Upgrading from previous versions
Contributors
License


Install


[npm][]:

  1. ```sh
  2. npm install superagent
  3. ```

[yarn][]:

  1. ```sh
  2. yarn add superagent
  3. ```


Usage


Node


  1. ``` js
  2. const superagent = require('superagent');

  4. // callback
  5. superagent
  6.   .post('/api/pet')
  7.   .send({ name: 'Manny', species: 'cat' }) // sends a JSON post body
  8.   .set('X-API-Key', 'foobar')
  9.   .set('accept', 'json')
  10.   .end((err, res) => {
  11.     // Calling the end function will send the request
  12.   });

  14. // promise with then/catch
  15. superagent.post('/api/pet').then(console.log).catch(console.error);

  17. // promise with async/await
  18. (async () => {
  19.   try {
  20.     const res = await superagent.post('/api/pet');
  21.     console.log(res);
  22.   } catch (err) {
  23.     console.error(err);
  24.   }
  25. })();
  26. ```

Browser


The browser-ready, minified version of superagent is only 50 KB (minified and gzipped).

Browser-ready versions of this module are available via [jsdelivr][], [unpkg][], and also in the node_modules/superagent/dist folder in downloads of the superagent package.

Note that we also provide unminified versions with .js instead of .min.js file extensions.


VanillaJS


This is the solution for you if you're just using `