MDN self-hosted library · e01.org

Blob: stream() method

File API

no runnable cells web-api-instance-method upstream source

File API

The stream() method of the Blob interface returns a ReadableStream which upon reading returns the data contained within the Blob as chunks of raw bytes.

Syntax

stream()

Parameters

None.

Return value

A ReadableStream which, upon reading, returns the contents of the Blob.

Usage notes

With stream() and the returned ReadableStream, you gain several interesting capabilities:

  • Call getReader() on the returned stream to get an object to use to read the data from the blob using methods such as the ReadableStreamDefaultReader interface's read() method.
  • Call the returned stream's pipeTo() method to pipe the blob's data to a writable stream.
  • Call the returned stream's tee() method to tee the readable stream. This returns an array containing two new ReadableStream objects, each of which returns the contents of the Blob.
  • Call the returned stream's pipeThrough() method to pipe the stream through a TransformStream or any other readable and writable pair.

    [!NOTE] Blob.textStream() is a useful shortcut that immediately returns a ReadableStream of UTF-8 text chunks.

Specifications

Browser compatibility

See also