Add support for typed arrays as request body

Fixes #2417

Author: sindresorhus

documentation/2-options.md

@@ -293,11 +293,11 @@ stream.on('data', console.log);
 
 ### `body`
 
-**Type: `string | Buffer | stream.Readable | Generator | AsyncGenerator | Iterable | AsyncIterable | FormData` or [`form-data` instance](https://github.com/form-data/form-data)**
+**Type: `string | Buffer | TypedArray | stream.Readable | Generator | AsyncGenerator | Iterable | AsyncIterable | FormData` or [`form-data` instance](https://github.com/form-data/form-data)**
 
 The payload to send.
 
-For `string` and `Buffer` types, the `content-length` header is automatically set if the `content-length` and `transfer-encoding` headers are missing.
+For `string`, `Buffer`, and `TypedArray` types (Uint8Array, Uint16Array, etc.), the `content-length` header is automatically set if the `content-length` and `transfer-encoding` headers are missing.
 
 **The `content-length` header is not automatically set when `body` is an instance of [`fs.createReadStream()`](https://nodejs.org/api/fs.html#fs_fs_createreadstream_path_options).**
 
@@ -331,6 +331,21 @@ console.log(data);
 //=> 'Hello, world!'
 ```
 
+You can also use typed arrays (Uint8Array, Uint16Array, etc.) as request body:
+
+```js
+import got from 'got';
+
+const uint8Body = new Uint8Array([104, 101, 108, 108, 111]); // 'hello' in ASCII
+
+const {data} = await got.post('https://httpbin.org/anything', {
+	body: uint8Body
+}).json();
+
+console.log(data);
+//=> 'hello'
+```
+
 You can use `Iterable` and `AsyncIterable` objects as request body, including Web [`ReadableStream`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream):
 
 ```js

source/core/index.ts

@@ -1028,6 +1028,17 @@ export default class Request extends Duplex implements RequestEvents<Request> {
 
 		if (is.nodeStream(body)) {
 			body.pipe(currentRequest);
+		} else if (is.buffer(body)) {
+			// Buffer should be sent directly without conversion
+			this._writeRequest(body, undefined, () => {});
+			currentRequest.end();
+		} else if (is.typedArray(body)) {
+			// Typed arrays should be treated like buffers, not iterated over
+			// Create a Uint8Array view over the data (Node.js streams accept Uint8Array)
+			const typedArray = body as ArrayBufferView;
+			const uint8View = new Uint8Array(typedArray.buffer, typedArray.byteOffset, typedArray.byteLength);
+			this._writeRequest(uint8View, undefined, () => {});
+			currentRequest.end();
 		} else if (is.asyncIterable(body) || (is.iterable(body) && !is.string(body) && !isBuffer(body))) {
 			(async () => {
 				try {

source/core/options.ts

@@ -1410,7 +1410,7 @@ export default class Options {
 
 	__Note #4__: This option is not enumerable and will not be merged with the instance defaults.
 
-	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`.
+	The `content-length` header will be automatically set if `body` is a `string` / `Buffer` / typed array ([`Uint8Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array), etc.) / [`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`.
 
@@ -1431,12 +1431,12 @@ export default class Options {
 	});
 	```
 	*/
-	get body(): string | Buffer | Readable | Generator | AsyncGenerator | Iterable<unknown> | AsyncIterable<unknown> | FormDataLike | undefined {
+	get body(): string | Buffer | Readable | Generator | AsyncGenerator | Iterable<unknown> | AsyncIterable<unknown> | FormDataLike | ArrayBufferView | undefined {
 		return this._internals.body;
 	}
 
-	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);
+	set body(value: string | Buffer | Readable | Generator | AsyncGenerator | Iterable<unknown> | AsyncIterable<unknown> | FormDataLike | ArrayBufferView | undefined) {
+		assert.any([is.string, is.buffer, is.nodeStream, is.generator, is.asyncGenerator, is.iterable, is.asyncIterable, isFormData, is.typedArray, is.undefined], value);
 
 		if (is.nodeStream(value)) {
 			assert.truthy(value.readable);

source/core/utils/get-body-size.ts

@@ -21,6 +21,10 @@ export default async function getBodySize(body: unknown, headers: ClientRequestA
 		return body.length;
 	}
 
+	if (is.typedArray(body)) {
+		return (body as ArrayBufferView).byteLength;
+	}
+
 	if (isFormData(body)) {
 		try {
 			return await promisify(body.getLength.bind(body))();

test/post.ts

@@ -76,6 +76,33 @@ test('sends Buffers', withServer, async (t, server, got) => {
 	t.is(body, 'wow');
 });
 
+test('sends Uint8Array', withServer, async (t, server, got) => {
+	server.post('/', defaultEndpoint);
+
+	const uint8Body = new Uint8Array([119, 111, 119]); // 'wow' in ASCII
+	const {body} = await got.post({body: uint8Body});
+	t.is(body, 'wow');
+});
+
+test('sends Uint16Array', withServer, async (t, server, got) => {
+	server.post('/', defaultEndpoint);
+
+	const text = 'hello';
+	const buffer = Buffer.from(text);
+	const uint16Body = new Uint16Array(buffer.buffer, buffer.byteOffset, buffer.byteLength / Uint16Array.BYTES_PER_ELEMENT);
+	const {body} = await got.post({body: uint16Body});
+	t.is(Buffer.from(uint16Body.buffer, uint16Body.byteOffset, uint16Body.byteLength).toString(), body);
+});
+
+test('`content-length` header with Uint8Array body', withServer, async (t, server, got) => {
+	server.post('/', echoHeaders);
+
+	const uint8Body = new Uint8Array([119, 111, 119]);
+	const {body} = await got.post({body: uint8Body});
+	const headers = JSON.parse(body);
+	t.is(headers['content-length'], '3');
+});
+
 test('sends Streams', withServer, async (t, server, got) => {
 	server.post('/', defaultEndpoint);