GitHub

HTTP Client Utilities

Lead Maintainer: Wyatt Preul

Usage

Basic

const Wreck = require('wreck');

Wreck.get('https://google.com/', (err, res, payload) => {
    /* do stuff */
});

const Wreck = require('wreck');

Wreck.post('https://posttestserver.com/post.php', { payload: { hello: 'post' } }, (err, res, payload) => {
    /* do stuff */
});

With Async/Await

const Wreck = require('wreck');

async function example () {
  const { req, res, payload } = await Wreck.get('http://example.com');
  console.log(payload.toString());
}

try {
  example();
} catch (ex) {
  console.error(ex);
}

Advanced

const Wreck = require('wreck');

const method = 'GET'; // GET, POST, PUT, DELETE
const uri = '/';
const readableStream = Wreck.toReadableStream('foo=bar');

const wreck = Wreck.defaults({
    headers: { 'x-foo-bar': 123 },
    agents: {
        https: new Https.Agent({ maxSockets: 100 }),
        http: new Http.Agent({ maxSockets: 1000 }),
        httpsAllowUnauthorized: new Https.Agent({ maxSockets: 100, rejectUnauthorized: false })
    }
});

// cascading example -- does not alter `wreck`
// inherits `headers` and `agents` specified above
const wreckWithTimeout = wreck.defaults({
    timeout: 5
});

// all attributes are optional
const options = {
    baseUrl: 'https://www.example.com',
    payload: readableStream || 'foo=bar' || new Buffer('foo=bar'),
    headers: { /* http headers */ },
    redirects: 3,
    beforeRedirect: function (redirectMethod, statusCode, location, resHeaders, redirectOptions, next) { return next() },
    redirected: function (statusCode, location, req) {},
    timeout: 1000,    // 1 second, default: unlimited
    maxBytes: 1048576, // 1 MB, default: unlimited
    rejectUnauthorized: true || false,
    downstreamRes: null,
    agent: null,         // Node Core http.Agent
    secureProtocol: 'SSLv3_method', // The SSL method to use
    ciphers: 'DES-CBC3-SHA' // The TLS ciphers to support
};

const optionalCallback = (err, res) => {

    /* handle err if it exists, in which case res will be undefined */

    // buffer the response stream
    Wreck.read(res, null, (err, body) => {
        /* do stuff */
    });
};

const req = wreck.request(method, uri, options, optionalCallback);

`defaults(options)`

Returns a new instance of Wreck which merges the provided options with those provided on a per-request basis. You can call defaults repeatedly to build up multiple http clients.

options - Config object containing settings for both request and read operations.

`request(method, uri, [options, [callback]])`

Initiate an HTTP request.

method - A string specifying the HTTP request method, defaulting to 'GET'.
uri - The URI of the requested resource.
options - An optional configuration object. To omit this argument but still use a callback, pass null in this position. The options object supports the following optional keys:
- baseUrl - fully qualified uri string used as the base url. Most useful with request.defaults, for example when you want to do many requests to the same domain. If baseUrl is https://example.com/api/, then requesting /end/point?test=true will fetch https://example.com/api/end/point?test=true. Any querystring in the baseUrl will be overwritten with the querystring in the uri When baseUrl is given, uri must also be a string.
- socketPath - /path/to/unix/socket for Server.
- payload - The request body as a string, Buffer, Readable Stream, or an object that can be serialized using JSON.stringify().
- headers - An object containing request headers.
- onRequest - A function that is called when a request is available using the signature function(req) where req is a ClientRequest.
- redirects - The maximum number of redirects to follow.
- redirect303 - if true, a HTTP 303 status code will redirect using a GET method. Defaults to no redirection on 303.
- beforeRedirect - A callback function that is called before a redirect is triggered, using the signature function(redirectMethod, statusCode, location, resHeaders, redirectOptions, next) where: - redirectMethod - A string specifying the redirect method. - statusCode - HTTP status code of the response that triggered the redirect. - location - The redirect location string. - resHeaders - An object with the headers received as part of the redirection response. - redirectOptions - Options that will be applied to the redirect request. Changes to this object are applied to the redirection request. - next - the callback function called to perform the redirection using signature function().
- redirected - A callback function that is called when a redirect was triggered, using the signature function(statusCode, location, req) where:
  - statusCode - HTTP status code of the response that triggered the redirect.
  - location - The redirected location string.
  - req - The new ClientRequest object which replaces the one initially returned.
- timeout - The number of milliseconds to wait without receiving a response before aborting the request. Defaults to unlimited.
- maxBytes - maximum size for response payload. Defaults to unlimited.
- rejectUnauthorized - TLS flag indicating whether the client should reject a response from a server with invalid certificates. This cannot be set at the same time as the agent option is set.
- downstreamRes: downstream Resource dependency.
- agent - Node Core http.Agent. Defaults to either wreck.agents.http or wreck.agents.https. Setting to false disables agent pooling.
- secureProtocol - TLS flag indicating the SSL method to use, e.g. SSLv3_method to force SSL version 3. The possible values depend on your installation of OpenSSL. Read the official OpenSSL docs for possible SSL_METHODS.
- ciphers - TLS list of TLS ciphers to override node's default.
  The possible values depend on your installation of OpenSSL. Read the official OpenSSL docs for possible TLS_CIPHERS.
callback - The optional callback function using the signature function (err, response) where:
- err - Any error that may have occurred during the handling of the request.
- response - The HTTP Incoming Message object, which is also a readable stream.

Returns an instance of the node.js ClientRequest object.

`read(response, options, callback)`

response - An HTTP Incoming Message object.
options - null or a configuration object with the following optional keys:
- timeout - The number of milliseconds to wait while reading data before aborting handling of the response. Defaults to unlimited.
- json - A value indicating how to try to parse the payload as JSON. Defaults to undefined meaning no parse logic.
  - true, 'smart' - only try JSON.parse if the response indicates a JSON content-type.
  - strict - as 'smart', except returns an error for non-JSON content-type.
  - force - try JSON.parse regardless of the content-type header.
- gunzip - A value indicating the behavior to adopt when the payload is gzipped. Defaults to undefined meaning no gunzipping.
  - true - only try to gunzip if the response indicates a gzip content-encoding.
  - false - explicitly disable gunzipping.
  - force - try to gunzip regardless of the content-encoding header.
- maxBytes - The maximum allowed response payload size. Defaults to unlimited.
callback - The callback function using the signature function (err, payload) where:
- err - Any error that may have occurred while reading the response.
- payload - The payload in the form of a Buffer or (optionally) parsed JavaScript object (JSON).

Notes about gunzip

When using gunzip, HTTP headers Content-Encoding, Content-Length, Content-Range and ETag won't reflect the reality as the payload has been uncompressed.

Node v4 does not detect premature ending of gzipped content, if the payload is partial, you will not get an error on this specific version of node.js.