HTTP Client Utilities
Lead Maintainer: Wyatt Preul
Usage
const Wreck = ; const example = { const res payload = await Wreck; console;}; try ;catch ex console;
Advanced
const Wreck = ; const method = 'GET'; // GET, POST, PUT, DELETEconst uri = '/';const readableStream = Wreck; const wreck = Wreck; // cascading example -- does not alter `wreck`// inherits `headers` and `agents` specified aboveconst wreckWithTimeout = wreck; // all attributes are optionalconst options = baseUrl: 'https://www.example.com' payload: readableStream || 'foo=bar' || Buffer headers: /* http headers */ redirects: 3 {} 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 example = { const promise = wreck; try const res = await promise; const body = await Wreck; console; catch err // Handle errors };
Use promise.req.abort()
to terminate the request early. Note that this is limited to the initial request only.
If the request was already redirected, aborting the original request will not abort execution of pending redirections.
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 bothrequest
andread
operations.
request(method, uri, [options])
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, passnull
in this position. The options object supports the following optional keys:baseUrl
- fully qualified uri string used as the base url. Most useful withrequest.defaults
, for example when you want to do many requests to the same domain. IfbaseUrl
ishttps://example.com/api/
, then requesting/end/point?test=true
will fetchhttps://example.com/api/end/point?test=true
. Any querystring in thebaseUrl
will be overwritten with the querystring in theuri
WhenbaseUrl
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 usingJSON.stringify()
.headers
- An object containing request headers.redirects
- The maximum number of redirects to follow.redirect303
- iftrue
, 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 signaturefunction(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 signaturefunction()
.redirected
- A callback function that is called when a redirect was triggered, using the signaturefunction(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.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 theagent
option is set.downstreamRes
: downstream Resource dependency.agent
- Node Core http.Agent. Defaults to eitherwreck.agents.http
orwreck.agents.https
. Setting tofalse
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.
Returns a promise that resolves into a node response object. The promise has a req
property which is the instance of the node.js
ClientRequest object.
read(response, options)
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 toundefined
meaning no parse logic.true
, 'smart' - only tryJSON.parse
if the response indicates a JSON content-type.strict
- as 'smart', except returns an error for non-JSON content-type.force
- tryJSON.parse
regardless of the content-type header.
gunzip
- A value indicating the behavior to adopt when the payload is gzipped. Defaults toundefined
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.
Returns a promise that resolves into 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.
get(uri, [options])
Convenience method for GET operations.
uri
- The URI of the requested resource.options
- Optional config object containing settings for bothrequest
andread
operations.
Returns a promise that resolves into an object with the following properties:
- res
- The HTTP Incoming Message
object, which is a readable stream that has "ended" and contains no more data to read.
- payload
- The payload in the form of a Buffer or (optionally) parsed JavaScript object (JSON).
Throws any error that may have occurred during handling of the request or a Boom error object if the response has an error status
code (i.e. 4xx or 5xx). If the error is a boom error object it will have the following properties in addition to the standard boom
properties:
- data.isResponseError
- boolean, indicates if the error is a result of an error response status code
- data.headers
- object containing the response headers
- data.payload
- the payload in the form of a Buffer or as a parsed object
- data.res
- the HTTP Incoming Message object
post(uri, [options])
Convenience method for POST operations.
uri
- The URI of the requested resource.options
- Optional config object containing settings for bothrequest
andread
operations.
Returns a promise that resolves into an object with the following properties:
- res
- The HTTP Incoming Message
object, which is a readable stream that has "ended" and contains no more data to read.
- payload
- The payload in the form of a Buffer or (optionally) parsed JavaScript object (JSON).
Throws any error that may have occurred during handling of the request or a Boom error object if the response has an error status
code (i.e. 4xx or 5xx). If the error is a boom error object it will have the following properties in addition to the standard boom
properties:
- data.isResponseError
- boolean, indicates if the error is a result of an error response status code
- data.headers
- object containing the response headers
- data.payload
- the payload in the form of a Buffer or as a parsed object
- data.res
- the HTTP Incoming Message object
patch(uri, [options])
Convenience method for PATCH operations.
uri
- The URI of the requested resource.options
- Optional config object containing settings for bothrequest
andread
operations.
Returns a promise that resolves into an object with the following properties:
- res
- The HTTP Incoming Message
object, which is a readable stream that has "ended" and contains no more data to read.
- payload
- The payload in the form of a Buffer or (optionally) parsed JavaScript object (JSON).
Throws any error that may have occurred during handling of the request or a Boom error object if the response has an error status
code (i.e. 4xx or 5xx). If the error is a boom error object it will have the following properties in addition to the standard boom
properties:
- data.isResponseError
- boolean, indicates if the error is a result of an error response status code
- data.headers
- object containing the response headers
- data.payload
- the payload in the form of a Buffer or as a parsed object
- data.res
- the HTTP Incoming Message object
put(uri, [options])
Convenience method for PUT operations.
uri
- The URI of the requested resource.options
- Optional config object containing settings for bothrequest
andread
operations.
Returns a promise that resolves into an object with the following properties:
- res
- The HTTP Incoming Message
object, which is a readable stream that has "ended" and contains no more data to read.
- payload
- The payload in the form of a Buffer or (optionally) parsed JavaScript object (JSON).
Throws any error that may have occurred during handling of the request or a Boom error object if the response has an error status
code (i.e. 4xx or 5xx). If the error is a boom error object it will have the following properties in addition to the standard boom
properties:
- data.isResponseError
- boolean, indicates if the error is a result of an error response status code
- data.headers
- object containing the response headers
- data.payload
- the payload in the form of a Buffer or as a parsed object
- data.res
- the HTTP Incoming Message object
delete(uri, [options])
Convenience method for DELETE operations.
uri
- The URI of the requested resource.options
- Optional config object containing settings for bothrequest
andread
operations.
Returns a promise that resolves into an object with the following properties:
- res
- The HTTP Incoming Message
object, which is a readable stream that has "ended" and contains no more data to read.
- payload
- The payload in the form of a Buffer or (optionally) parsed JavaScript object (JSON).
Throws any error that may have occurred during handling of the request or a Boom error object if the response has an error status
code (i.e. 4xx or 5xx). If the error is a boom error object it will have the following properties in addition to the standard boom
properties:
- data.isResponseError
- boolean, indicates if the error is a result of an error response status code
- data.headers
- object containing the response headers
- data.payload
- the payload in the form of a Buffer or as a parsed object
- data.res
- the HTTP Incoming Message object
toReadableStream(payload, [encoding])
Creates a readable stream for the provided payload and encoding.
payload
- The Buffer or string to be wrapped in a readable stream.encoding
- The encoding to use. Must be a valid Buffer encoding, such as 'utf8' or 'ascii'.
const stream = Wreck;const read = stream;// read -> 'Hello'
parseCacheControl(field)
Parses the provided cache-control request header value into an object containing
a property for each directive and it's value. Boolean directives, such as "private"
or "no-cache" will be set to the boolean true
.
field
- The header cache control value to be parsed.
const result = Wreck;// result.private -> true// result['max-age'] -> 0// result['no-cache'] -> true
agents
Object that contains the agents for pooling connections for http
and https
.
The properties are http
, https
, and httpsAllowUnauthorized
which is an
https
agent with rejectUnauthorized
set to false. All agents have
maxSockets
configured to Infinity
. They are each instances of the Node.js
Agent and expose the
standard properties.
For example, the following code demonstrates changing maxSockets
on the http
agent.
const Wreck = ; WreckagentshttpmaxSockets = 20;
Below is another example that sets the certificate details for all HTTPS requests.
const HTTPS = ;const Wreck = ; Wreckagentshttps = cert key ca;
Events
To enable events, use Wreck.defaults({ events: true })
. Events are available via the
events
emitter attached to the client returned by Wreck.defaults()
.
request
The request event is emitted just before wreck makes a request. The
handler should accept the following arguments (uri, options)
where:
uri
- the result ofUrl.parse(uri)
. This will provide information about the resource requested. Also includes the headers and method.options
- the options passed into the request function. This will include a payload if there is one.
Since the request
event executes on a global event handler, you can intercept
and decorate a request before its sent.
response
The response event is always emitted for any request that wreck makes. The
handler should accept the following arguments (err, details)
where:
err
- a Boom errordetails
- object with the following propertiesreq
- the rawClientHttp
request objectres
- the rawIncomingMessage
response objectstart
- the time that the request was initiateduri
- the result ofUrl.parse(uri)
. This will provide information about the resource requested. Also includes the headers and method.
This event is useful for logging all requests that go through wreck. The err
and res
arguments can be undefined depending on if an error occurs. Please
be aware that if multiple modules are depending on the same cached wreck
module that this event can fire for each request made across all modules. The
start
property is the timestamp when the request was started. This can be
useful for determining how long it takes wreck to get a response back and
processed.