Support Iterable and AsyncIterable as request body

Fixes #2392

Author: sindresorhus

documentation/2-options.md

@@ -293,7 +293,7 @@ stream.on('data', console.log);
 
 ### `body`
 
-**Type: `string | Buffer | stream.Readable | Generator | AsyncGenerator | FormData` or [`form-data` instance](https://github.com/form-data/form-data)**
+**Type: `string | Buffer | stream.Readable | Generator | AsyncGenerator | Iterable | AsyncIterable | FormData` or [`form-data` instance](https://github.com/form-data/form-data)**
 
 The payload to send.
 
@@ -312,6 +312,22 @@ console.log(data);
 //=> 'Hello, world!'
 ```
 
+You can use `Iterable` and `AsyncIterable` objects as request body, including Web [`ReadableStream`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream):
+
+```js
+import got from 'got';
+
+// Using an async generator
+async function* generateData() {
+	yield 'Hello, ';
+	yield 'world!';
+}
+
+await got.post('https://httpbin.org/anything', {
+	body: generateData()
+});
+```
+
 Since Got 12, you can use spec-compliant [`FormData`](https://developer.mozilla.org/en-US/docs/Web/API/FormData) objects as request body, such as [`formdata-node`](https://github.com/octet-stream/form-data) or [`formdata-polyfill`](https://github.com/jimmywarting/FormData):
 
 ```js

source/core/index.ts

@@ -53,6 +53,8 @@ export type Progress = {
 const supportsBrotli = is.string(process.versions.brotli);
 
 const methodsWithoutBody: ReadonlySet<string> = new Set(['GET', 'HEAD']);
+// Methods that should auto-end streams when no body is provided
+const methodsWithoutBodyStream: ReadonlySet<string> = new Set(['OPTIONS', 'DELETE', 'PATCH']);
 
 export type GotEventFunction<T> =
 	/**
@@ -976,7 +978,7 @@ export default class Request extends Duplex implements RequestEvents<Request> {
 
 		if (is.nodeStream(body)) {
 			body.pipe(currentRequest);
-		} else if (is.generator(body) || is.asyncGenerator(body)) {
+		} else if (is.asyncIterable(body) || (is.iterable(body) && !is.string(body) && !isBuffer(body))) {
 			(async () => {
 				try {
 					for await (const chunk of body) {
@@ -991,7 +993,9 @@ export default class Request extends Duplex implements RequestEvents<Request> {
 		} else if (is.undefined(body)) {
 			// No body to send, end the request
 			const cannotHaveBody = methodsWithoutBody.has(this.options.method) && !(this.options.method === 'GET' && this.options.allowGetBody);
-			if ((this._noPipe ?? false) || cannotHaveBody || currentRequest !== this) {
+			const shouldAutoEndStream = methodsWithoutBodyStream.has(this.options.method);
+
+			if ((this._noPipe ?? false) || cannotHaveBody || currentRequest !== this || shouldAutoEndStream) {
 				currentRequest.end();
 			}
 		} else {

source/core/options.ts

@@ -1342,13 +1342,30 @@ export default class Options {
 	The `content-length` header will be automatically set if `body` is a `string` / `Buffer` / [`FormData`](https://developer.mozilla.org/en-US/docs/Web/API/FormData) / [`form-data` instance](https://github.com/form-data/form-data), and `content-length` and `transfer-encoding` are not manually set in `options.headers`.
 
 	Since Got 12, the `content-length` is not automatically set when `body` is a `fs.createReadStream`.
+
+	You can use `Iterable` and `AsyncIterable` objects as request body, including Web [`ReadableStream`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream):
+
+	@example
+	```
+	import got from 'got';
+
+	// Using an async generator
+	async function* generateData() {
+		yield 'Hello, ';
+		yield 'world!';
+	}
+
+	await got.post('https://httpbin.org/anything', {
+		body: generateData()
+	});
+	```
 	*/
-	get body(): string | Buffer | Readable | Generator | AsyncGenerator | FormDataLike | undefined {
+	get body(): string | Buffer | Readable | Generator | AsyncGenerator | Iterable<unknown> | AsyncIterable<unknown> | FormDataLike | undefined {
 		return this._internals.body;
 	}
 
-	set body(value: string | Buffer | Readable | Generator | AsyncGenerator | FormDataLike | undefined) {
-		assert.any([is.string, is.buffer, is.nodeStream, is.generator, is.asyncGenerator, isFormData, is.undefined], value);
+	set body(value: string | Buffer | Readable | Generator | AsyncGenerator | Iterable<unknown> | AsyncIterable<unknown> | FormDataLike | undefined) {
+		assert.any([is.string, is.buffer, is.nodeStream, is.generator, is.asyncGenerator, is.iterable, is.asyncIterable, isFormData, is.undefined], value);
 
 		if (is.nodeStream(value)) {
 			assert.truthy(value.readable);

test/hooks.ts

@@ -1315,7 +1315,7 @@ test('`beforeRequest` change body', withServer, async (t, server, got) => {
 			beforeRequest: [
 				options => {
 					options.body = JSON.stringify({payload: 'new'});
-					options.headers['content-length'] = options.body.length.toString();
+					options.headers['content-length'] = (options.body as string).length.toString();
 				},
 			],
 		},

test/post.ts

@@ -443,3 +443,33 @@ test('formdata retry', withServer, async (t, server, got) => {
 		message: 'Cannot retry with consumed body stream',
 	});
 });
+
+test('body - sends async iterable', withServer, async (t, server, got) => {
+	server.post('/', defaultEndpoint);
+
+	async function * generateData() {
+		yield 'Hello, ';
+		yield 'world!';
+	}
+
+	const body = await got.post({
+		body: generateData(),
+	}).text();
+
+	t.is(body, 'Hello, world!');
+});
+
+test('body - sends iterable', withServer, async (t, server, got) => {
+	server.post('/', defaultEndpoint);
+
+	function * generateData() {
+		yield 'foo';
+		yield 'bar';
+	}
+
+	const body = await got.post({
+		body: generateData(),
+	}).text();
+
+	t.is(body, 'foobar');
+});