![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)
req-then
Wraps node's built-in http(s) request
function with a few extras:
- Returns a promise, resolving to an object containing the data, node response and original request.
- If data was supplied, sets a
content-length
header if not already present. - Automatically selects
http
or https
transport depending on the input URL. - Cancellable (which
fetch
is not).
Example
const request = require('req-then')
request('http://www.bbc.co.uk')
.then(response => {
console.log('Response received', response.data)
console.log('The nodejs response instance', response.res)
})
.catch(console.error)
request(reqOptions, [data]) ⇒ external:Promise
⏏
Returns a promise for the response.
Kind: Exported function
Resolve: object
- res
will be the node response object, data
will be the data, req
the original request.
Reject: Error
- If aborted, the name
property of the error will be aborted
.
Param | Type | Description |
---|
reqOptions | string | object | Target url string or a standard node.js http request options object. |
[reqOptions.controller] | object | If supplied, an .abort() method will be created on it which, if invoked, will cancel the request. Cancelling will cause the returned promise to reject with an 'aborted' error. |
[data] | * | Data to send with the request. |
© 2015-16 Lloyd Brookes <75pound@gmail.com>. Documented by jsdoc-to-markdown.