Allow calling of got.stream via options (#452)

Juan Soto · sindresorhus · commit b26c51e50f16 · 2018-02-11T22:19:45.000+07:00
Fixes #362
diff --git a/index.js b/index.js
@@ -586,7 +586,13 @@ function normalizeArguments(url, opts) {
 
 function got(url, opts) {
 	try {
-		return asPromise(normalizeArguments(url, opts));
+		const normalizedArgs = normalizeArguments(url, opts);
+
+		if (normalizedArgs.stream) {
+			return asStream(normalizedArgs);
+		}
+
+		return asPromise(normalizedArgs);
 	} catch (err) {
 		return Promise.reject(err);
 	}
diff --git a/readme.md b/readme.md
@@ -105,6 +105,13 @@ Type: `Object`
 
 Any of the [`http.request`](http://nodejs.org/api/http.html#http_http_request_options_callback) options.
 
+###### stream
+
+Type: `boolean`<br>
+Default: `false`
+
+Returns a `Stream` instead of a `Promise`. This is equivalent to calling `got.stream(url, [options])`.
+
 ###### body
 
 Type: `string` `Buffer` `stream.Readable`
diff --git a/test/arguments.js b/test/arguments.js
@@ -1,5 +1,6 @@
 import {URL} from 'universal-url';
 import test from 'ava';
+import pEvent from 'p-event';
 import got from '..';
 import {createServer} from './helpers/server';
 
@@ -21,6 +22,10 @@ test.before('setup', async () => {
 		res.end(req.url);
 	});
 
+	s.on('/stream', (req, res) => {
+		res.end('ok');
+	});
+
 	await s.listen(s.port);
 });
 
@@ -81,6 +86,16 @@ test('WHATWG URL support', async t => {
 	await t.notThrows(got(wURL));
 });
 
+test('should return streams when using stream option', async t => {
+	const data = await pEvent(got(`${s.url}/stream`, {stream: true}), 'data');
+	t.is(data.toString(), 'ok');
+});
+
+test('should not allow stream and JSON option at the same time', async t => {
+	const error = await t.throws(got(`${s.url}/stream`, {stream: true, json: true}));
+	t.is(error.message, 'Got can not be used as a stream when the `json` option is used');
+});
+
 test.after('cleanup', async () => {
 	await s.close();
 });
