This module is an implementation of Node's native
http module for the browser.
It tries to match Node's API and behavior as closely as possible, but some features
aren't available, since browsers don't give nearly as much control over requests.
This is heavily inspired by, and intended to replace, http-browserify.
What does it do?
In accordance with its name,
stream-http tries to provide data to its caller before
the request has completed whenever possible.
Backpressure, allowing the browser to only pull data from the server as fast as it is consumed, is supported in:
- Chrome >= 58 (using
The following browsers support true streaming, where only a small amount of the request has to be held in memory at once:
- Chrome >= 43 (using the
- Firefox >= 9 (using
moz-chunked-arraybufferresponseType with xhr)
All other supported browsers support pseudo-streaming, where the data is available before the request finishes, but the entire response must be held in memory. This works for both text and binary data.
As of version 3.0.0, IE10 and below are no longer supported. IE11 support will remain for now.
How do you use it?
The intent is to have the same API as the client part of the Node HTTP module. The interfaces are the same wherever practical, although limitations in browsers make an exact clone of the Node API impossible.
This module implements
http.get, and most of
http.IncomingMessage in addition to
http.STATUS_CODES. See the
Node docs for how these work.
Extra features compared to Node
message.urlproperty provides access to the final URL after all redirects. This is useful since the browser follows all redirects silently, unlike Node. It is available in Chrome 37 and newer, Firefox 32 and newer, and Safari 9 and newer.
options.withCredentialsboolean flag, used to indicate if the browser should send cookies or authentication information with a CORS request. Default false.
This module has to make some tradeoffs to support binary data and/or streaming. Generally, the module can make a fairly good decision about which underlying browser features to use, but sometimes it helps to get a little input from the developer.
options.modefield passed into
http.getcan take on one of the following values:
- 'default' (or any falsy value, including
- 'allow-wrong-content-type': Provides partial data in more cases than 'default', but at the expense of causing the 'content-type' response header to be incorrectly reported (as 'text/plain; charset=x-user-defined') in some browsers, notably Safari and Chrome 42 and older. Preserves binary data whenever possible. In some cases the implementation may also be a bit slow. This was the default in versions of this module before 1.5.
- 'prefer-stream': Provide data before the request completes even if binary data (anything that isn't a single-byte ASCII or UTF8 character) will be corrupted. Of course, this option is only safe for text data. May also cause the 'content-type' response header to be incorrectly reported (as 'text/plain; charset=x-user-defined').
- 'disable-fetch': Force the use of plain XHR regardless of the browser declaring a fetch capability. Preserves the correctness of binary data and the 'content-type' response header.
- 'prefer-fast': Deprecated; now a synonym for 'default', which has the same performance characteristics as this mode did in versions before 1.5.
- 'default' (or any falsy value, including
options.requestTimeoutallows setting a timeout in millisecionds for XHR and fetch (if supported by the browser). This is a limit on how long the entire process takes from beginning to end. Note that this is not the same as the node
setTimeoutfunctions, which apply to pauses in data transfer over the underlying socket, or the node
timeoutoption, which applies to opening the connection.
Features missing compared to Node
http.Agentis only a stub
- The 'socket', 'connect', 'upgrade', and 'continue' events on
- Any operations, including
request.setTimeout, that operate directly on the underlying socket.
- Any options that are disallowed for security reasons. This includes setting or getting certain headers.
message.rawHeadersis modified by the browser, and may not quite match what is sent by the server.
message.rawTrailerswill remain empty.
- Redirects are followed silently by the browser, so it isn't possible to access the 301/302 redirect pages.
setTimeoutfunctions, which operate on the underlying socket, are not available. However, see
There are two sets of tests: the tests that run in Node (found in
test/node) and the tests
that run in the browser (found in
test/browser). Normally the browser tests run on
npm test will run both sets of tests, but in order for the Sauce Labs tests to run
you will need to sign up for an account (free for open source projects) and put the
credentials in a
You will also need to run a Sauce Connect Proxy
with the same credentials.
To run just the Node tests, run
npm run test-node.
To run the browser tests locally, run
npm run test-browser-local and point your browser to
the link shown in your terminal.
MIT. Copyright (C) John Hiesey and other contributors.