superagent

elegant & feature rich browser / node HTTP with a fluent API

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
superagent
8.0.02 months ago11 years agoMinified + gzip package size for superagent in KB

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

Node Browser Required Browser Features

Install

npm install superagent
yarn add superagent

Usage

Node

const superagent = require('superagent');

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

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

// promise with async/await
(async () => {
  try {
    const res = await superagent.post('/api/pet');
    console.log(res);
  } catch (err) {
    console.error(err);
  }
})();

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 <script> tags everywhere!
<script src="https://polyfill.io/v3/polyfill.min.js?features=WeakRef,BigInt"></script>
<script src="https://cdn.jsdelivr.net/npm/superagent"></script>
<!-- if you wish to use unpkg.com instead: -->
<!-- <script src="https://unpkg.com/superagent"></script> -->
<script type="text/javascript">
  (function() {
    // superagent is exposed as `window.superagent`
    // if you wish to use "request" instead please
    // uncomment the following line of code:
    // `window.request = superagent;`
    superagent
      .post('/api/pet')
      .send({ name: 'Manny', species: 'cat' }) // sends a JSON post body
      .set('X-API-Key', 'foobar')
      .set('accept', 'json')
      .end(function (err, res) {
        // Calling the end function will send the request
      });
  })();
</script>

Bundler

If you are using browserify, webpack, rollup, or another bundler, then you can follow the same usage as Node above.

Supported Platforms


```sh npx browserslist ```
```sh andchr 102 andff 101 andqq 10.4 anduc 12.12 android 101 chrome 103 chrome 102 chrome 101 chrome 100 edge 103 edge 102 edge 101 firefox 101 firefox 100 firefox 91 iossaf 15.5 iossaf 15.4 iossaf 15.2-15.3 iossaf 15.0-15.1 iossaf 14.5-14.8 iossaf 14.0-14.4 iossaf 12.2-12.5 kaios 2.5 opmini all opmob 64 opera 86 opera 85 safari 15.5 safari 15.4 samsung 17.0 samsung 16.0 ```

Required Browser Features

We recommend using (specifically with the bundle mentioned in VanillaJS
above):
<script src="https://polyfill.io/v3/polyfill.min.js?features=WeakRef,BigInt"></script>

  • WeakRef is not supported in Opera 85, iOS Safari 12.2-12.5
  • BigInt is not supported in iOS Safari 12.2-12.5

Plugins

SuperAgent is easily extended via plugins.
const nocache = require('superagent-no-cache');
const superagent = require('superagent');
const prefix = require('superagent-prefix')('/static');

superagent
  .get('/some-url')
  .query({ action: 'edit', city: 'London' }) // query string
  .use(prefix) // Prefixes *only* this request
  .use(nocache) // Prevents caching of *only* this request
  .end((err, res) => {
    // Do something
  });

Existing plugins:

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.

Upgrading from previous versions

Please see GitHub releases page for the current changelog.
Our breaking changes are mostly in rarely used functionality and from stricter error handling.
Browser behaviour changed to match Node when serializing application/x-www-form-urlencoded, using arrayFormat: 'indices' semantics of qs library. (See: ) Retry behavior is still opt-in, however we now have a more fine-grained list of status codes and error codes that we retry against (see updated docs) A specific issue with Content-Type matching not being case-insensitive is fixed Set is now required for IE 9, see Required Browser Features for more insight We've implemented the build setup of Lass to simplify our stack and linting Unminified browserified build size has been reduced from 48KB to 20KB (via tinyify and the latest version of Babel using @babel/preset-env and .browserslistrc) Linting support has been added using caniuse-lite and eslint-plugin-compat We can now target what versions of Node we wish to support more easily using .babelrc Ensure you're running Node 6 or later. We've dropped support for Node 4. We've started using ES6 and for compatibility with Internet Explorer you may need to use Babel. We suggest migrating from .end() callbacks to .then() or await. Ensure you're running Node 4 or later. We've dropped support for Node 0.x. Test code that calls .send() multiple times. Invalid calls to .send() will now throw instead of sending garbage. If you use .parse() in the browser version, rename it to .serialize(). If you rely on undefined in query-string values being sent literally as the text "undefined", switch to checking for missing value instead. ?key=undefined is now ?key (without a value). If you use .then() in Internet Explorer, ensure that you have a polyfill that adds a global Promise object.
  • 0.x to 1.x:
Instead of 1-argument callback .end(function(res){}) use .then(res => {}).

Contributors

| Name | | ------------------- | | Kornel Lesiński | | Peter Lyons | | Hunter Loftis | | Nick Baugh |

License

MIT © TJ Holowaychuk
#