feat(opts.ignoreBody): add a boolean to throw away response bodies

Author: zkat

README.md

@@ -232,6 +232,16 @@ Additional headers for the outgoing request. This option can also be used to
 override headers automatically generated by `npm-registry-fetch`, such as
 `Content-Type`.
 
+##### <a name="opts-ignore-body"></a> `opts.ignore-body`
+
+* Alias: `opts.ignoreBody`
+* Type: Boolean
+* Default: false
+
+If true, the **response body** will be thrown away and `res.body` set to `null`.
+This will prevent dangling response sockets for requests where you don't usually
+care what the response body is.
+
 ##### <a name="opts-integrity"></a> `opts.integrity`
 
 * Type: String | [SRI object](https://npm.im/ssri)

check-response.js

@@ -16,6 +16,10 @@ function checkResponse (method, res, registry, startTime, opts) {
     return checkErrors(method, res, startTime, opts)
   } else {
     res.body.on('end', () => logRequest(method, res, startTime, opts))
+    if (opts.ignoreBody) {
+      res.body.resume()
+      res.body = null
+    }
     return res
   }
 }

config.js

@@ -23,6 +23,8 @@ module.exports = figgyPudding({
   'gzip': {},
   'headers': {},
   'https-proxy': {},
+  'ignore-body': {},
+  ignoreBody: 'ignore-body',
   'integrity': {},
   'is-from-ci': 'isFromCI',
   'isFromCI': {

test/index.js

@@ -237,6 +237,16 @@ test('json()', t => {
     .then(json => t.deepEqual(json, {hello: 'world'}, 'got json body'))
 })
 
+test('opts.ignoreBody', t => {
+  tnock(t, OPTS.registry)
+    .get('/hello')
+    .reply(200, {hello: 'world'})
+  return fetch('/hello', OPTS.concat({ignoreBody: true}))
+    .then(res => {
+      t.equal(res.body, null, 'body omitted')
+    })
+})
+
 test('method configurable', t => {
   tnock(t, OPTS.registry)
     .delete('/hello')