readableStreamToArrayBuffer

Bun

Symbol

readableStreamToArrayBuffer

function readableStreamToArrayBuffer(stream: ReadableStream<ArrayBufferLike | ArrayBufferView<ArrayBufferLike>>): ArrayBuffer | Promise<ArrayBuffer>

Consume all data from a ReadableStream until it closes or errors.

Concatenate the chunks into a single ArrayBuffer.

Each chunk must be a TypedArray or an ArrayBuffer. If you need to support chunks of different types, consider readableStreamToBlob

@param stream

The stream to consume.

@returns

A promise that resolves with the concatenated chunks or the concatenated chunks as an ArrayBuffer.

Referenced types

class ReadableStream<R = any>

This Streams API interface represents a readable stream of byte data. The Fetch API offers a concrete instance of a ReadableStream through the body property of a Response object.

MDN Reference

type ArrayBufferView<TArrayBuffer extends ArrayBufferLike = ArrayBufferLike> = NodeJS.TypedArray<TArrayBuffer> | DataView<TArrayBuffer>

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