@gthole/simpleagent v1.0.1

SimpleAgent

A NodeJS simplified version of SuperAgent.js for making JSON HTTP requests.

Why?

Superagent is great! It lets you structure your requests cleanly and programmatically.

But it's also pretty heavy - it contains lots of features that aren't necessary for making simple JSON requests, which are most of the requests I make most of the time. If I'm bundling up a small Lambda function, it's better to have a super small library to provide the same functionality without all the extra stuff.

SimpleAgent:

• Can probably do most of what you need for API requests
• Has no production dependencies
• Is small: roughly 100 lines of code
• Is typed with Typescript
• Has good test coverage

Installation

Easy enough:

$ npm install --save @gthole/simpleagent

What's Supported?

Basic JSON requests work just fine:

const request = require('@gthole/simpleagent');

// Auth and query strings
request
    .get('http://www.example.com')
    .auth('my-user', 'pass')
    .query({name: 'bananas'})
    .end((err, resp) => {
        // Do something
    });

// Promises, within an async function
const resp = await request
    .get('http://www.example.com/foo?bar=baz')
    .promise();

// Sending JSON bodies, HTTPS, and setting headers
request
    .post('https://api.example.com/v1/fruit')
    .set('Authorization', 'Bearer ' + myApiKey)
    .send({name: 'banana', type: 'peel'})
    .then((resp) => {
        // Do something
    });

What Isn't Supported?

Everything else.

Features that are left out:

• Content-Types besides JSON: no type, accept or serialize methods.
• Piping response data: Data loaded directly into memory
• Sessions: Cookies not saved
• Progress Tracking: Don't use it for big uploads
• Browser version: Node only
• Retrying request: Do that manually if you want it
• TLS options: Maybe will add these later
• Aborts / Timeouts
• Following Redirects
• Plugins, etc.