Skip to main content

toArray

method ReadableBase.prototype.toArray
Jump to headingReadableBase.prototype.toArray(options?: Pick<ArrayOptions, "signal">): Promise<any[]>

This method allows easily obtaining the contents of a stream.

As this method reads the entire stream into memory, it negates the benefits of streams. It's intended for interoperability and convenience, not as the primary way to consume streams.

Parameters Jump to heading

optional
Jump to headingoptions: Pick<ArrayOptions, "signal">

Return Type Jump to heading

Promise<any[]>

a promise containing an array with the contents of the stream.

Back to top