function

stream.consumers.text

function text(

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

): Promise<string>;

import { text } from 'node:stream/consumers';
import { Readable } from 'node:stream';

const readable = Readable.from('Hello world from consumers!');
const data = await text(readable);
console.log(`from readable: ${data.length}`);
// Prints: from readable: 27

@returns

Fulfills with the contents of the stream parsed as a UTF-8 encoded string.

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>;