http-request-plus

Small package that provides a promise-based, stream-oriented wrapper around the http and https modules.

Features:

• HTTP & HTTPs
• promise oriented
• stream oriented
• request body can be either a buffer/string or a stream
• content length header automatically set if available
• handle redirects
• response emits error on timeout

Install

Installation of the npm package:

> npm install --save http-request-plus

Usage

Example

Easy use case: just downloads and prints a page with error handling.

ES2015 - ES2016:

1import httpRequestPlus from "http-request-plus";
2
3async function main() {
4  // this is a standard Node's IncomingMessage augmented with the following method:
5  //
6  // - buffer(): returns a promise to the content of the response in a Buffer
7  // - json(): returns a promise to the content of the response parsed as JSON
8  // - text(): returns a promise to the content of the response parsed as a UTF-8 string
9  const response = await httpRequestPlus("http://example.org", {
10    // A request body can provided, either as a buffer/string or a stream
11    body: "foo bar",
12
13    // By default, http-request-plus throws if the reponse's status Code is not 2xx
14    //
15    // This option can be used to bypass this
16    bypassStatusCheck: true,
17
18    // Maximum number of redirects that should be handled by http-request-plus
19    //
20    // Defaults to 5
21    maxRedirects: 0,
22
23    // all other options are forwarded to native {http,https}.request()
24    //
25    // including `timeout` and `signal` which will properly trigger errors
26  });
27
28  // any error occuring after the response has been received, including abortion,
29  // timeout, or body error (if body is a stream) will be emitted as an `error`
30  // event on the response object
31
32  console.log(await response.text());
33}
34
35main().catch((error) => console.error("FATAL:", error));

Contributions

Contributions are very welcomed, either on the documentation or on the code.

You may:

• report any issue you've encountered;
• fork and create a pull request.

Related Resources

• Node.js HTTP Documentation
• Node.js HTTPS Documentation

License

ISC © Julien Fontanet