function

stream.consumers.arrayBuffer

stream: ReadableStream | AsyncIterable<any, any, any> | ReadableStream<any>

import { arrayBuffer } from 'node:stream/consumers';
import { Readable } from 'node:stream';
import { TextEncoder } from 'node:util';

const encoder = new TextEncoder();
const dataArray = encoder.encode('hello world from consumers!');

const readable = Readable.from(dataArray);
const data = await arrayBuffer(readable);
console.log(`from readable: ${data.byteLength}`);
// Prints: from readable: 76

@returns

Fulfills with an ArrayBuffer containing the full contents of the stream.

Referenced types

interface ReadableStream<R = any>

readonly locked: boolean
cancel(
reason?: any
): Promise<void>;
getReader(
options: { mode: 'byob' }
): ReadableStreamBYOBReader;
getReader(): ReadableStreamDefaultReader<R>;
getReader(
options?: ReadableStreamGetReaderOptions
): ReadableStreamReader<R>;
pipeThrough<T>(
transform: ReadableWritablePair<T, R>,
options?: StreamPipeOptions
): ReadableStream<T>;
pipeTo(
destination: WritableStream<R>,
options?: StreamPipeOptions
): Promise<void>;
tee(): [ReadableStream<R>, ReadableStream<R>];
values(
options?: ReadableStreamIteratorOptions
): ReadableStreamAsyncIterator<R>;

class ArrayBuffer

Represents a raw buffer of binary data, which is used to store data for the different typed arrays. ArrayBuffers cannot be read from or written to directly, but can be passed to a typed array or DataView Object to interpret the raw buffer as needed.

readonly [Symbol.toStringTag]: string
readonly byteLength: number
Read-only. The length of the ArrayBuffer (in bytes).
resize(
newByteLength?: number
): void;
Resizes the ArrayBuffer to the specified size (in bytes).
MDN
resize(
byteLength: number
): ArrayBuffer;
Resize an ArrayBuffer in-place.
slice(
begin: number,
end?: number
): ArrayBuffer;
Returns a section of an ArrayBuffer.
transfer(
newByteLength?: number
): ArrayBuffer;
Creates a new ArrayBuffer with the same byte content as this buffer, then detaches this buffer.
MDN
transferToFixedLength(
newByteLength?: number
): ArrayBuffer;
Creates a new non-resizable ArrayBuffer with the same byte content as this buffer, then detaches this buffer.
MDN