Compare commits
No commits in common. "bc4f6e59c0ab3473cd54f1ee299f28d145e63e58" and "2e9a643c0f6991490d9aa3d66a2e156c973e7a13" have entirely different histories.
bc4f6e59c0
...
2e9a643c0f
|
@ -1,6 +0,0 @@
|
||||||
# CHANGELOG
|
|
||||||
|
|
||||||
## v1.8.0
|
|
||||||
|
|
||||||
- add `resp.ok` - same as WHATWG fetch `resp.ok = (resp.statusCode >= 200 && resp.statusCode < 300)`
|
|
||||||
- add `resp.stream.body()` to populate `resp.body` rather than (or perhaps in addition to) continuing to stream (useful for error handling)
|
|
30
EXTRA.md
30
EXTRA.md
|
@ -3,36 +3,6 @@
|
||||||
There are some niche features of @root/request which are beyond the request.js
|
There are some niche features of @root/request which are beyond the request.js
|
||||||
compatibility.
|
compatibility.
|
||||||
|
|
||||||
## async/await & Promises
|
|
||||||
|
|
||||||
The differences in async support are explained in [README.md](/README.md), up near the top.
|
|
||||||
|
|
||||||
If you're familiar with Promises (and async/await), then it's pretty self-explanatory.
|
|
||||||
|
|
||||||
## ok
|
|
||||||
|
|
||||||
Just like WHATWG `fetch`, we have `resp.ok`:
|
|
||||||
|
|
||||||
```js
|
|
||||||
let resp = await request({
|
|
||||||
url: 'https://example.com'
|
|
||||||
}).then(mustOk);
|
|
||||||
```
|
|
||||||
|
|
||||||
```js
|
|
||||||
function mustOk(resp) {
|
|
||||||
if (!resp.ok) {
|
|
||||||
// handle error
|
|
||||||
throw new Error('BAD RESPONSE');
|
|
||||||
}
|
|
||||||
return resp;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## streams
|
|
||||||
|
|
||||||
The differences in stream support are explained in [README.md](/README.md), up near the top.
|
|
||||||
|
|
||||||
## userAgent
|
## userAgent
|
||||||
|
|
||||||
There's a default User-Agent string describing the version of @root/request, node.js, and the OS.
|
There's a default User-Agent string describing the version of @root/request, node.js, and the OS.
|
||||||
|
|
35
README.md
35
README.md
|
@ -10,7 +10,7 @@ Written from scratch, with zero-dependencies.
|
||||||
|
|
||||||
## Super simple to use
|
## Super simple to use
|
||||||
|
|
||||||
@root/request is designed to be a drop-in replacement for request. It also supports Promises and async/await by default, enhanced stream support, and a few other things as mentioned below.
|
@root/request is designed to be a drop-in replacement for request. It also supports Promises and async/await by default.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm install --save @root/request
|
npm install --save @root/request
|
||||||
|
@ -51,7 +51,7 @@ read, the streaming behavior is **_slightly different_** from that of
|
||||||
```diff
|
```diff
|
||||||
-var request = require('request');
|
-var request = require('request');
|
||||||
+var request = require('@root/request');
|
+var request = require('@root/request');
|
||||||
|
|
||||||
-var stream = request({ url, headers });
|
-var stream = request({ url, headers });
|
||||||
+var stream = await request({ url, headers });
|
+var stream = await request({ url, headers });
|
||||||
|
|
||||||
|
@ -105,42 +105,17 @@ request({
|
||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
Also, `await resp.stream.body()` can be used to get back the full body (the same as if you didn't use the `stream` option:
|
|
||||||
|
|
||||||
```js
|
|
||||||
let resp = await request({
|
|
||||||
url: 'http://www.google.com',
|
|
||||||
stream: true
|
|
||||||
});
|
|
||||||
if (!resp.ok) {
|
|
||||||
await resp.stream.body();
|
|
||||||
console.error(resp.body);
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Table of contents
|
## Table of contents
|
||||||
|
|
||||||
- [Extra Features](/EXTRA.md)
|
|
||||||
- [Forms](#forms)
|
- [Forms](#forms)
|
||||||
- [HTTP Authentication](#http-authentication)
|
- [HTTP Authentication](#http-authentication)
|
||||||
- [Custom HTTP Headers](#custom-http-headers)
|
- [Custom HTTP Headers](#custom-http-headers)
|
||||||
- [Unix Domain Sockets](#unix-domain-sockets)
|
- [Unix Domain Sockets](#unix-domain-sockets)
|
||||||
- [**All Available Options**](#requestoptions-callback)
|
- [**All Available Options**](#requestoptions-callback)
|
||||||
|
|
||||||
## Extra Features
|
|
||||||
|
|
||||||
The following are features that the original `request` did not have, but have been added for convenience in `@root/request`.
|
|
||||||
|
|
||||||
- Support for `async`/`await` & `Promise`s (as explained above)
|
|
||||||
- `request({ userAgent: 'my-api/1.1' })` (for building API clients)
|
|
||||||
- `resp.ok` (just like `fetch`)
|
|
||||||
- `resp.stream` (see above)
|
|
||||||
|
|
||||||
See [EXTRA.md](/EXTRA.md)
|
|
||||||
|
|
||||||
## Forms
|
## Forms
|
||||||
|
|
||||||
`@root/request` supports `application/x-www-form-urlencoded` and `multipart/form-data` form uploads.
|
`urequest` supports `application/x-www-form-urlencoded` and `multipart/form-data` form uploads.
|
||||||
|
|
||||||
<!-- For `multipart/related` refer to the `multipart` API. -->
|
<!-- For `multipart/related` refer to the `multipart` API. -->
|
||||||
|
|
||||||
|
@ -335,7 +310,7 @@ request(options, callback);
|
||||||
|
|
||||||
## UNIX Domain Sockets
|
## UNIX Domain Sockets
|
||||||
|
|
||||||
`@root/request` supports making requests to [UNIX Domain Sockets](https://en.wikipedia.org/wiki/Unix_domain_socket). To make one, use the following URL scheme:
|
`urequest` supports making requests to [UNIX Domain Sockets](https://en.wikipedia.org/wiki/Unix_domain_socket). To make one, use the following URL scheme:
|
||||||
|
|
||||||
```js
|
```js
|
||||||
/* Pattern */ 'http://unix:SOCKET:PATH';
|
/* Pattern */ 'http://unix:SOCKET:PATH';
|
||||||
|
@ -451,7 +426,7 @@ These HTTP method convenience functions act just like `request()` but with a def
|
||||||
|
|
||||||
There are at least <!--three--> two ways to debug the operation of `request`:
|
There are at least <!--three--> two ways to debug the operation of `request`:
|
||||||
|
|
||||||
1. Launch the node process like `NODE_DEBUG=@root/request node script.js`
|
1. Launch the node process like `NODE_DEBUG=urequest node script.js`
|
||||||
(`lib,request,otherlib` works too).
|
(`lib,request,otherlib` works too).
|
||||||
|
|
||||||
2. Set `require('@root/request').debug = true` at any time (this does the same thing
|
2. Set `require('@root/request').debug = true` at any time (this does the same thing
|
||||||
|
|
201
index.js
201
index.js
|
@ -66,102 +66,6 @@ function toJSONifier(keys) {
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
function setupPipe(resp, opts) {
|
|
||||||
// make the response await-able
|
|
||||||
var resolve;
|
|
||||||
var reject;
|
|
||||||
var p = new Promise(function (_resolve, _reject) {
|
|
||||||
resolve = _resolve;
|
|
||||||
reject = _reject;
|
|
||||||
});
|
|
||||||
|
|
||||||
// or an existing write stream
|
|
||||||
if ('function' === typeof opts.stream.pipe) {
|
|
||||||
if (opts.debug) {
|
|
||||||
console.debug('[@root/request] stream piped');
|
|
||||||
}
|
|
||||||
resp.pipe(opts.stream);
|
|
||||||
}
|
|
||||||
resp.once('error', function (e) {
|
|
||||||
if (opts.debug) {
|
|
||||||
console.debug("[@root/request] stream 'error'");
|
|
||||||
console.error(e.stack);
|
|
||||||
}
|
|
||||||
resp.destroy();
|
|
||||||
if ('function' === opts.stream.destroy) {
|
|
||||||
opts.stream.destroy(e);
|
|
||||||
}
|
|
||||||
reject(e);
|
|
||||||
});
|
|
||||||
resp.once('end', function () {
|
|
||||||
if (opts.debug) {
|
|
||||||
console.debug("[@root/request] stream 'end'");
|
|
||||||
}
|
|
||||||
if ('function' === opts.stream.destroy) {
|
|
||||||
opts.stream.end();
|
|
||||||
// this will close the stream (i.e. sync to disk)
|
|
||||||
opts.stream.destroy();
|
|
||||||
}
|
|
||||||
});
|
|
||||||
resp.once('close', function () {
|
|
||||||
if (opts.debug) {
|
|
||||||
console.debug("[@root/request] stream 'close'");
|
|
||||||
}
|
|
||||||
resolve();
|
|
||||||
});
|
|
||||||
return p;
|
|
||||||
}
|
|
||||||
|
|
||||||
function handleResponse(resp, opts, cb) {
|
|
||||||
// body can be buffer, string, or json
|
|
||||||
if (null === opts.encoding) {
|
|
||||||
resp._body = [];
|
|
||||||
} else {
|
|
||||||
resp.body = '';
|
|
||||||
}
|
|
||||||
resp._bodyLength = 0;
|
|
||||||
resp.on('readable', function () {
|
|
||||||
var chunk;
|
|
||||||
while ((chunk = resp.read())) {
|
|
||||||
if ('string' === typeof resp.body) {
|
|
||||||
resp.body += chunk.toString(opts.encoding);
|
|
||||||
} else {
|
|
||||||
resp._body.push(chunk);
|
|
||||||
resp._bodyLength += chunk.length;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
});
|
|
||||||
resp.once('end', function () {
|
|
||||||
if ('string' !== typeof resp.body) {
|
|
||||||
if (1 === resp._body.length) {
|
|
||||||
resp.body = resp._body[0];
|
|
||||||
} else {
|
|
||||||
resp.body = Buffer.concat(resp._body, resp._bodyLength);
|
|
||||||
}
|
|
||||||
resp._body = null;
|
|
||||||
}
|
|
||||||
if (opts.json && 'string' === typeof resp.body) {
|
|
||||||
// TODO I would parse based on Content-Type
|
|
||||||
// but request.js doesn't do that.
|
|
||||||
try {
|
|
||||||
resp.body = JSON.parse(resp.body);
|
|
||||||
} catch (e) {
|
|
||||||
// ignore
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
debug('\n[urequest] resp.toJSON():');
|
|
||||||
if (module.exports.debug) {
|
|
||||||
debug(resp.toJSON());
|
|
||||||
}
|
|
||||||
if (opts.debug) {
|
|
||||||
console.debug('[@root/request] Response Body:');
|
|
||||||
console.debug(resp.body);
|
|
||||||
}
|
|
||||||
cb(null, resp, resp.body);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
function setDefaults(defs) {
|
function setDefaults(defs) {
|
||||||
defs = defs || {};
|
defs = defs || {};
|
||||||
|
|
||||||
|
@ -196,16 +100,9 @@ function setDefaults(defs) {
|
||||||
});
|
});
|
||||||
followRedirect = opts.followRedirect;
|
followRedirect = opts.followRedirect;
|
||||||
|
|
||||||
// copied from WHATWG fetch
|
|
||||||
resp.ok = false;
|
|
||||||
if (resp.statusCode >= 200 && resp.statusCode < 300) {
|
|
||||||
resp.ok = true;
|
|
||||||
}
|
|
||||||
|
|
||||||
resp.toJSON = toJSONifier([
|
resp.toJSON = toJSONifier([
|
||||||
'statusCode',
|
'statusCode',
|
||||||
'body',
|
'body',
|
||||||
'ok',
|
|
||||||
'headers',
|
'headers',
|
||||||
'request'
|
'request'
|
||||||
]);
|
]);
|
||||||
|
@ -259,18 +156,96 @@ function setDefaults(defs) {
|
||||||
}
|
}
|
||||||
|
|
||||||
if (opts.stream) {
|
if (opts.stream) {
|
||||||
resp.stream = setupPipe(resp, opts);
|
// make the response await-able
|
||||||
// can be string, buffer, or json... why not an async function too?
|
var resolve;
|
||||||
resp.stream.body = async function () {
|
var reject;
|
||||||
handleResponse(resp, opts, cb);
|
resp.stream = new Promise(function (_resolve, _reject) {
|
||||||
await resp.stream;
|
resolve = _resolve;
|
||||||
return resp.body;
|
reject = _reject;
|
||||||
};
|
});
|
||||||
|
|
||||||
|
// or an existing write stream
|
||||||
|
if ('function' === typeof opts.stream.pipe) {
|
||||||
|
if (opts.debug) {
|
||||||
|
console.debug('[@root/request] stream piped');
|
||||||
|
}
|
||||||
|
resp.pipe(opts.stream);
|
||||||
|
}
|
||||||
|
resp.on('error', function (e) {
|
||||||
|
if (opts.debug) {
|
||||||
|
console.debug("[@root/request] stream 'error'");
|
||||||
|
console.error(e.stack);
|
||||||
|
}
|
||||||
|
resp.destroy();
|
||||||
|
if ('function' === opts.stream.destroy) {
|
||||||
|
opts.stream.destroy(e);
|
||||||
|
}
|
||||||
|
reject(e);
|
||||||
|
});
|
||||||
|
resp.on('end', function () {
|
||||||
|
if (opts.debug) {
|
||||||
|
console.debug("[@root/request] stream 'end'");
|
||||||
|
}
|
||||||
|
if ('function' === opts.stream.destroy) {
|
||||||
|
opts.stream.end();
|
||||||
|
// this will close the stream (i.e. sync to disk)
|
||||||
|
opts.stream.destroy();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
resp.on('close', function () {
|
||||||
|
if (opts.debug) {
|
||||||
|
console.debug("[@root/request] stream 'close'");
|
||||||
|
}
|
||||||
|
resolve();
|
||||||
|
});
|
||||||
|
// and in all cases, return the stream
|
||||||
cb(null, resp);
|
cb(null, resp);
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
handleResponse(resp, opts, cb);
|
if (null === opts.encoding) {
|
||||||
|
resp._body = [];
|
||||||
|
} else {
|
||||||
|
resp.body = '';
|
||||||
|
}
|
||||||
|
resp._bodyLength = 0;
|
||||||
|
resp.on('data', function (chunk) {
|
||||||
|
if ('string' === typeof resp.body) {
|
||||||
|
resp.body += chunk.toString(opts.encoding);
|
||||||
|
} else {
|
||||||
|
resp._body.push(chunk);
|
||||||
|
resp._bodyLength += chunk.length;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
resp.on('end', function () {
|
||||||
|
if ('string' !== typeof resp.body) {
|
||||||
|
if (1 === resp._body.length) {
|
||||||
|
resp.body = resp._body[0];
|
||||||
|
} else {
|
||||||
|
resp.body = Buffer.concat(resp._body, resp._bodyLength);
|
||||||
|
}
|
||||||
|
resp._body = null;
|
||||||
|
}
|
||||||
|
if (opts.json && 'string' === typeof resp.body) {
|
||||||
|
// TODO I would parse based on Content-Type
|
||||||
|
// but request.js doesn't do that.
|
||||||
|
try {
|
||||||
|
resp.body = JSON.parse(resp.body);
|
||||||
|
} catch (e) {
|
||||||
|
// ignore
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
debug('\n[urequest] resp.toJSON():');
|
||||||
|
if (module.exports.debug) {
|
||||||
|
debug(resp.toJSON());
|
||||||
|
}
|
||||||
|
if (opts.debug) {
|
||||||
|
console.debug('[@root/request] Response Body:');
|
||||||
|
console.debug(resp.body);
|
||||||
|
}
|
||||||
|
cb(null, resp, resp.body);
|
||||||
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
var _body;
|
var _body;
|
||||||
|
@ -462,7 +437,7 @@ function setDefaults(defs) {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
req = requester.request(finalOpts, onResponse);
|
req = requester.request(finalOpts, onResponse);
|
||||||
req.once('error', cb);
|
req.on('error', cb);
|
||||||
|
|
||||||
if (_body) {
|
if (_body) {
|
||||||
debug("\n[urequest] '" + finalOpts.method + "' (request) body");
|
debug("\n[urequest] '" + finalOpts.method + "' (request) body");
|
||||||
|
@ -470,7 +445,7 @@ function setDefaults(defs) {
|
||||||
if ('function' === typeof _body.pipe) {
|
if ('function' === typeof _body.pipe) {
|
||||||
// used for chunked encoding
|
// used for chunked encoding
|
||||||
_body.pipe(req);
|
_body.pipe(req);
|
||||||
_body.once('error', function (err) {
|
_body.on('error', function (err) {
|
||||||
// https://nodejs.org/api/stream.html#stream_readable_pipe_destination_options
|
// https://nodejs.org/api/stream.html#stream_readable_pipe_destination_options
|
||||||
// if the Readable stream emits an error during processing,
|
// if the Readable stream emits an error during processing,
|
||||||
// the Writable destination is not closed automatically
|
// the Writable destination is not closed automatically
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
{
|
{
|
||||||
"name": "@root/request",
|
"name": "@root/request",
|
||||||
"version": "1.8.0",
|
"version": "1.7.0",
|
||||||
"lockfileVersion": 1
|
"lockfileVersion": 1
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
{
|
{
|
||||||
"name": "@root/request",
|
"name": "@root/request",
|
||||||
"version": "1.8.0",
|
"version": "1.7.0",
|
||||||
"description": "A lightweight, zero-dependency drop-in replacement for request",
|
"description": "A lightweight, zero-dependency drop-in replacement for request",
|
||||||
"main": "index.js",
|
"main": "index.js",
|
||||||
"files": [
|
"files": [
|
||||||
|
|
Loading…
Reference in New Issue