A NodeJS simplified version of SuperAgent.js for making JSON HTTP requests.
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.
- Can probably do most of what you need for API requests
- Automatically requests and parses JSON
- Automatically requests and decodes gzip/brotli responses
- Handles retry logic and timeout aborts
- Only uses standard libraries, no production dependencies
- Is small: roughly 300 lines of code
- Is typed with Typescript
- Has good test coverage
Easy enough:
$ npm install --save simpleragentSimplerAgent is intended to be used for basic JSON requests.
Calls return a Promise-like object that plays well with async/await.
Import with require:
const { request, Response } = require('simpleragent');
const request = require('simpleragent');or with import in Typescript
import { request, Response, ResponseError } from 'simpleragent';
import { get, put } from 'simpleragent';Requests are Promises-first and can be await'ed:
const resp = await request.get('https://www.example.com')
.auth('my-user', 'pass')
.query({name: 'bananas'});
// The response body string is available in the "text" attribute of
// the response.
console.log(resp.text);
// The "body" attribute contains the JSON-parsed body (or null if
// parsing failed).
console.log(resp.body);You can also use callbacks with the end method:
request.get('http://www.example.com').end((err, resp) => ... );Drop JSON into the send method. Don't worry about setting the Content-Type,
it's set to application/json for you.
// Sending JSON bodies, HTTPS, and setting headers, using callbacks
await request
.post('https://api.example.com/v1/fruit')
.set('Authorization', 'Bearer ' + myApiKey)
.send({name: 'banana', type: 'peel'});Errors are thrown for non-2xx responses, with the status code, request object, and response object on the thrown error.
try {
const resp = await request.get('http://www.example.com/return-400');
} catch (e) {
console.log(e.statusCode);
console.log(e.request);
console.log(e.response.body);
}If there is no http connection, then a ConnectionError is thrown, which
does not have a status or response set.
import { request, ConnectionError } from 'simpleragent';
try {
const resp = await request.get('http://not-a-real-domain/foo');
} catch (e) {
console.log(e instanceof ConnectionError);
}Simpleragent will auto-retry 5xx errors if you set a retry policy.
// A simple policy to retry 5xx errors five times
const resp = await request
.get('http://www.example.com/return-500')
.retry(5);
// A policy with optional delay and optional exponential backoff
try {
await request
.get('http://www.example.com/return-503')
.retry({retries: 3, delay: 100, backoff: 2});
} catch (e) {
// 5xx errors are thrown if retries are exhausted
// 4xx errors are thrown without retrying
console.log(e.statusCode);
}delay is the number of milliseconds to wait between retries, and backoff is
a multiplicative factor to apply to the delay with each retry.
Simpleragent can abort requests that do not complete within a certain period of
time. In these cases, an AbortError subclass of RequestError is thrown.
import { request, AbortError } from 'simpleragent';
// Set a 5 second timeout, which takes a milliseconds argument
try {
await request
.get('http://www.example.com/delay-10-seconds')
.timeout(5000);
} catch (e) {
// An error message indicates the timeout
assert.equal(err instanceof AbortError, true);
console.log(e.message);
}By default simpleragent does not follow redirects, but it can be configured to follow a limited number of redirections.
await request
.get('http://example.com/go-to-https')
.redirects(2);Subsequent redirects will throw a RequestError with statusCode of 300 or 301.
// Send a client certificate
await request
.get('https://my-mtls-endpoint.com/foo')
.cert(fs.readFileSync('agent-cert.pem'))
.key(fs.readFileSync('agent-key.pem'));getheadpostputpatchdelete
Clients reduce the overall boilerplate required for each request. If you have a client that makes multiple calls to an API, you can omit the base url and headers.
The Client constructor takes a path prefix as an argument. You can add or update
headers with the set method. Then use the client as you would simpleragent,
but without all the extra code.
import { Client } from 'simpleragent';
const client = new request.Client('https://www.example.com/api/v1');
// Set a header to be sent with all requests
client.set('x-api-key', process.env.SOME_API_KEY);
// Add a basic auth Authorization header
client.auth(username, password);
// Set a retry policy that will be applied to all requests
client.retry({retries: 3, delay: 200});
async function get() {
const resp = await client.get('/resource').query({foo: 'bar'});
return resp.body;
}
async function post(payload) {
const resp = await client.post('/resource').send(payload);
return resp.body.id;
}Client instances also support the cert and key options for client TLS.
Simpleragent supports a plugin interface that allows users to modify, retry, cache, or log requests.
import { Request, Response, IPlugin } from 'simpleragent';
class LoggingPlugin implements IPlugin {
start: number;
onRequest(req: Request) {
this.start = Date.now();
}
onResponse(req: Request, res: Response) {
console.log(`method=${req.method} path=${req.path} duration=${Date.now() - this.start}`);
}
}
const client = new Client('https://www.example.com')
.use(LoggingPlugin);
// All successful requests made with this client will log the statement
client.get('/some-path');Plugins should implement the IPlugin interface and be passed into the use
method via class name. They are instantiated at the start of a request and
reused for subsequent requests, so any plugin instance data (such as start
in the example above) is available between retries but reset at the start of
a new request. To have simpleragent retry a request, a plugin should return
{retry: true} from either a onResponse or onError plugin method.
Plugin methods available:
onRequest: Called before sending the request to the server. Adjustments can be made to the request at this point, such as adding a trace id header.onResponse: Called after a 2xx response is received from the server. Retry logic on successful responses could be implemented here, such as waiting for an asynchronous job request to complete.onError: Called when a non-2xx status is returned, or a connection error occurs.
Simpleragent internally uses plugins for its retry, redirect, and timeout
functionality.
Plugins are executed at each stage in the order that they're configured on the client or request object.
Everything else.
Features that are left out:
- Content-Types besides JSON: no
type,acceptorserializemethods. - 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