Node.js v25.0.0 文档

new ReadableStream([underlyingSource [, strategy]])#

• underlyingSource <Object>
  • start <Function> 一个用户定义的函数，在 ReadableStream 创建时立即被调用。
    • controller <ReadableStreamDefaultController> | <ReadableByteStreamController>
    • 返回：undefined 或一个解析为 undefined 的 promise。
  • pull <Function> 一个用户定义的函数，当 ReadableStream 内部队列未满时会重复调用。此操作可以是同步或异步的。如果是异步的，直到前一个返回的 promise 被兑现后，该函数才会再次被调用。
    • controller <ReadableStreamDefaultController> | <ReadableByteStreamController>
    • 返回：一个解析为 undefined 的 promise。
  • cancel <Function> 一个用户定义的函数，当 ReadableStream 被取消时调用。
    • reason <any>
    • 返回：一个解析为 undefined 的 promise。
  • type <string> 必须是 'bytes' 或 undefined。
  • autoAllocateChunkSize <number> 仅在 type 等于 'bytes' 时使用。当设置为非零值时，会自动为 ReadableByteStreamController.byobRequest 分配一个视图缓冲区。未设置时，必须使用流的内部队列通过默认读取器 ReadableStreamDefaultReader 来传输数据。
• strategy <Object>
  • highWaterMark <number> 在施加背压之前的最大内部队列大小。
  • size <Function> 一个用户定义的函数，用于确定每个数据块的大小。
    • chunk <any>
    • 返回：<number>

readableStream.locked#

• 类型: <boolean> 如果此 <ReadableStream> 有一个活动的读取器，则设置为 true。

readableStream.locked 属性默认为 false，当有活动的读取器消耗流数据时，会切换为 true。

readableStream.cancel([reason])#

• reason <any>
• 返回：一个在取消操作完成后解析为 undefined 的 promise。

readableStream.getReader([options])#

• options <Object>
  • mode <string> 'byob' 或 undefined
• 返回：<ReadableStreamDefaultReader> | <ReadableStreamBYOBReader>

import { ReadableStream } from 'node:stream/web';

const stream = new ReadableStream();

const reader = stream.getReader();

console.log(await reader.read());const { ReadableStream } = require('node:stream/web');

const stream = new ReadableStream();

const reader = stream.getReader();

reader.read().then(console.log);copy

使 readableStream.locked 变为 true。

readableStream.pipeThrough(transform[, options])#

• transform <Object>
  • readable <ReadableStream> transform.writable 会将从该 ReadableStream 接收到的可能已修改的数据推送到此 ReadableStream 中。
  • writable <WritableStream> 此 ReadableStream 的数据将被写入的 WritableStream。
• options <Object>
  • preventAbort <boolean> 当为 true 时，此 ReadableStream 中的错误不会导致 transform.writable 被中止。
  • preventCancel <boolean> 当为 true 时，目标 transform.writable 中的错误不会导致此 ReadableStream 被取消。
  • preventClose <boolean> 当为 true 时，关闭此 ReadableStream 不会导致 transform.writable 被关闭。
  • signal <AbortSignal> 允许使用 <AbortController> 来取消数据传输。
• 返回：<ReadableStream> 来自 transform.readable。

将此 <ReadableStream> 连接到 transform 参数中提供的一对 <ReadableStream> 和 <WritableStream>，使得此 <ReadableStream> 的数据被写入 transform.writable，可能经过转换，然后推送到 transform.readable。一旦管道配置完成，将返回 transform.readable。

在管道操作期间，使 readableStream.locked 变为 true。

import {
  ReadableStream,
  TransformStream,
} from 'node:stream/web';

const stream = new ReadableStream({
  start(controller) {
    controller.enqueue('a');
  },
});

const transform = new TransformStream({
  transform(chunk, controller) {
    controller.enqueue(chunk.toUpperCase());
  },
});

const transformedStream = stream.pipeThrough(transform);

for await (const chunk of transformedStream)
  console.log(chunk);
  // Prints: Aconst {
  ReadableStream,
  TransformStream,
} = require('node:stream/web');

const stream = new ReadableStream({
  start(controller) {
    controller.enqueue('a');
  },
});

const transform = new TransformStream({
  transform(chunk, controller) {
    controller.enqueue(chunk.toUpperCase());
  },
});

const transformedStream = stream.pipeThrough(transform);

(async () => {
  for await (const chunk of transformedStream)
    console.log(chunk);
    // Prints: A
})();copy

readableStream.pipeTo(destination[, options])#

• destination <WritableStream> 此 ReadableStream 的数据将被写入的 <WritableStream>。
• options <Object>
  • preventAbort <boolean> 当为 true 时，此 ReadableStream 中的错误不会导致 destination 被中止。
  • preventCancel <boolean> 当为 true 时，destination 中的错误不会导致此 ReadableStream 被取消。
  • preventClose <boolean> 当为 true 时，关闭此 ReadableStream 不会导致 destination 被关闭。
  • signal <AbortSignal> 允许使用 <AbortController> 来取消数据传输。
• 返回：一个解析为 undefined 的 promise

在管道操作期间，使 readableStream.locked 变为 true。

readableStream.tee()#

• 返回：<ReadableStream[]>

返回一对新的 <ReadableStream> 实例，此 ReadableStream 的数据将被转发到这两个实例中。每个实例将接收相同的数据。

使 readableStream.locked 变为 true。

readableStream.values([options])#

• options <Object>
  • preventCancel <boolean> 当为 true 时，可防止在异步迭代器突然终止时关闭 <ReadableStream>。默认值：false。

创建并返回一个可用于消费此 ReadableStream 数据的异步迭代器。

在异步迭代器活动期间，使 readableStream.locked 变为 true。

import { Buffer } from 'node:buffer';

const stream = new ReadableStream(getSomeSource());

for await (const chunk of stream.values({ preventCancel: true }))
  console.log(Buffer.from(chunk).toString()); copy

异步迭代#

<ReadableStream> 对象支持使用 for await 语法的异步迭代器协议。

import { Buffer } from 'node:buffer';

const stream = new ReadableStream(getSomeSource());

for await (const chunk of stream)
  console.log(Buffer.from(chunk).toString()); copy

异步迭代器将消费 <ReadableStream> 直到其终止。

默认情况下，如果异步迭代器提前退出（通过 break、return 或 throw），<ReadableStream> 将被关闭。为防止自动关闭 <ReadableStream>，请使用 readableStream.values() 方法获取异步迭代器，并将 preventCancel 选项设置为 true。

<ReadableStream> 必须未被锁定（即，它不能有已存在的活动读取器）。在异步迭代期间，<ReadableStream> 将被锁定。

使用 postMessage() 传输#

一个 <ReadableStream> 实例可以使用 <MessagePort> 进行传输。

const stream = new ReadableStream(getReadableSourceSomehow());

const { port1, port2 } = new MessageChannel();

port1.onmessage = ({ data }) => {
  data.getReader().read().then((chunk) => {
    console.log(chunk);
  });
};

port2.postMessage(stream, [stream]); copy

new ReadableStreamDefaultReader(stream)#

• stream <ReadableStream>

创建一个新的 <ReadableStreamDefaultReader>，并锁定到给定的 <ReadableStream>。

readableStreamDefaultReader.cancel([reason])#

• reason <any>
• 返回：一个解析为 undefined 的 promise。

取消 <ReadableStream> 并返回一个在底层流被取消时兑现的 promise。

readableStreamDefaultReader.closed#

• 类型: <Promise> 当关联的 <ReadableStream> 关闭时，解析为 undefined；如果流出错或在流完成关闭前读取器的锁被释放，则被拒绝。

readableStreamDefaultReader.read()#

• 返回：一个解析为对象的 promise
  • value <any>
  • done <boolean>

从底层的 <ReadableStream> 请求下一个数据块，并返回一个在数据可用时解析为该数据的 promise。

readableStreamDefaultReader.releaseLock()#

释放此读取器对底层 <ReadableStream> 的锁定。

new ReadableStreamBYOBReader(stream)#

• stream <ReadableStream>

创建一个新的 ReadableStreamBYOBReader，并锁定到给定的 <ReadableStream>。

readableStreamBYOBReader.cancel([reason])#

• reason <any>
• 返回：一个解析为 undefined 的 promise。

取消 <ReadableStream> 并返回一个在底层流被取消时兑现的 promise。

readableStreamBYOBReader.closed#

• 类型: <Promise> 当关联的 <ReadableStream> 关闭时，解析为 undefined；如果流出错或在流完成关闭前读取器的锁被释放，则被拒绝。

readableStreamBYOBReader.read(view[, options])#

• view <Buffer> | <TypedArray> | <DataView>
• options <Object>
  • min <number> 设置后，返回的 promise 只有在至少有 min 个元素可用时才会被兑现。未设置时，promise 在至少有一个元素可用时兑现。
• 返回：一个解析为对象的 promise
  • value <TypedArray> | <DataView>
  • done <boolean>

从底层的 <ReadableStream> 请求下一个数据块，并返回一个在数据可用时解析为该数据的 promise。

不要将池化的 <Buffer> 对象实例传递给此方法。池化的 Buffer 对象是使用 Buffer.allocUnsafe() 或 Buffer.from() 创建的，或者通常由各种 node:fs 模块的回调返回。这些类型的 Buffer 使用共享的底层 <ArrayBuffer> 对象，该对象包含所有池化 Buffer 实例的数据。当一个 Buffer、<TypedArray> 或 <DataView> 传递到 readableStreamBYOBReader.read() 中时，视图的底层 ArrayBuffer 会被分离，这会使该 ArrayBuffer 上的所有现有视图失效。这可能会对您的应用程序造成灾难性的后果。

readableStreamBYOBReader.releaseLock()#

释放此读取器对底层 <ReadableStream> 的锁定。

readableStreamDefaultController.close()#

关闭与此控制器关联的 <ReadableStream>。

readableStreamDefaultController.desiredSize#

• 类型：<number>

返回填满 <ReadableStream> 队列所需的剩余数据量。

readableStreamDefaultController.enqueue([chunk])#

• chunk <any>

将一个新的数据块附加到 <ReadableStream> 的队列中。

readableStreamDefaultController.error([error])#

• error <any>

发出一个错误信号，导致 <ReadableStream> 出错并关闭。

readableByteStreamController.byobRequest#

• 类型：<ReadableStreamBYOBRequest>

readableByteStreamController.close()#

关闭与此控制器关联的 <ReadableStream>。

readableByteStreamController.desiredSize#

• 类型：<number>

返回填满 <ReadableStream> 队列所需的剩余数据量。

readableByteStreamController.enqueue(chunk)#

• chunk <Buffer> | <TypedArray> | <DataView>

将一个新的数据块附加到 <ReadableStream> 的队列中。

readableByteStreamController.error([error])#

• error <any>

发出一个错误信号，导致 <ReadableStream> 出错并关闭。

readableStreamBYOBRequest.respond(bytesWritten)#

• bytesWritten <number>

通知已有 bytesWritten 数量的字节被写入到 readableStreamBYOBRequest.view。

readableStreamBYOBRequest.respondWithNewView(view)#

• view <Buffer> | <TypedArray> | <DataView>

通知请求已通过写入字节到一个新的 Buffer、TypedArray 或 DataView 中来完成。

readableStreamBYOBRequest.view#

• 类型：<Buffer> | <TypedArray> | <DataView>

new WritableStream([underlyingSink[, strategy]])#

• underlyingSink <Object>
  • start <Function> 一个用户定义的函数，在 WritableStream 创建时立即被调用。
    • controller <WritableStreamDefaultController>
    • 返回：undefined 或一个解析为 undefined 的 promise。
  • write <Function> 一个用户定义的函数，当一个数据块被写入 WritableStream 时调用。
    • chunk <any>
    • controller <WritableStreamDefaultController>
    • 返回：一个解析为 undefined 的 promise。
  • close <Function> 一个用户定义的函数，当 WritableStream 关闭时调用。
    • 返回：一个解析为 undefined 的 promise。
  • abort <Function> 一个用户定义的函数，用于突然关闭 WritableStream。
    • reason <any>
    • 返回：一个解析为 undefined 的 promise。
  • type <any> type 选项为将来使用保留，并且必须为 undefined。
• strategy <Object>
  • highWaterMark <number> 在施加背压之前的最大内部队列大小。
  • size <Function> 一个用户定义的函数，用于确定每个数据块的大小。
    • chunk <any>
    • 返回：<number>

writableStream.abort([reason])#

• reason <any>
• 返回：一个解析为 undefined 的 promise。

突然终止 WritableStream。所有排队的写入都将被取消，并且其关联的 promise 将被拒绝。

writableStream.close()#

• 返回：一个解析为 undefined 的 promise。

在预计没有更多写入时关闭 WritableStream。

writableStream.getWriter()#

• 返回：<WritableStreamDefaultWriter>

创建并返回一个新的写入器实例，可用于将数据写入 WritableStream。

writableStream.locked#

• 类型：<boolean>

writableStream.locked 属性默认为 false，当有活动的写入器附加到此 WritableStream 时，会切换为 true。

使用 postMessage() 传输#

一个 <WritableStream> 实例可以使用 <MessagePort> 进行传输。

const stream = new WritableStream(getWritableSinkSomehow());

const { port1, port2 } = new MessageChannel();

port1.onmessage = ({ data }) => {
  data.getWriter().write('hello');
};

port2.postMessage(stream, [stream]); copy

new WritableStreamDefaultWriter(stream)#

• stream <WritableStream>

创建一个新的 WritableStreamDefaultWriter，并锁定到给定的 WritableStream。

writableStreamDefaultWriter.abort([reason])#

• reason <any>
• 返回：一个解析为 undefined 的 promise。

突然终止 WritableStream。所有排队的写入都将被取消，并且其关联的 promise 将被拒绝。

writableStreamDefaultWriter.close()#

• 返回：一个解析为 undefined 的 promise。

在预计没有更多写入时关闭 WritableStream。

writableStreamDefaultWriter.closed#

• 类型: <Promise> 当关联的 <WritableStream> 关闭时，解析为 undefined；如果流出错或在流完成关闭前写入器的锁被释放，则被拒绝。

writableStreamDefaultWriter.desiredSize#

• 类型：<number>

填满 <WritableStream> 队列所需的数据量。

writableStreamDefaultWriter.ready#

• 类型: <Promise> 当写入器准备好使用时，解析为 undefined。

writableStreamDefaultWriter.releaseLock()#

释放此写入器对底层 <ReadableStream> 的锁定。

writableStreamDefaultWriter.write([chunk])#

• chunk <any>
• 返回：一个解析为 undefined 的 promise。

将一个新的数据块附加到 <WritableStream> 的队列中。

writableStreamDefaultController.error([error])#

• error <any>

由用户代码调用，以通知在处理 WritableStream 数据时发生错误。调用时，<WritableStream> 将被中止，当前待处理的写入将被取消。

writableStreamDefaultController.signal#

• 类型: <AbortSignal> 一个 AbortSignal，可用于在 <WritableStream> 被中止时取消待处理的写入或关闭操作。

new TransformStream([transformer[, writableStrategy[, readableStrategy]]])#

• transformer <Object>
  • start <Function> 一个用户定义的函数，在 TransformStream 创建时立即被调用。
    • controller <TransformStreamDefaultController>
    • 返回：undefined 或一个解析为 undefined 的 promise
  • transform <Function> 一个用户定义的函数，接收并可能修改写入 transformStream.writable 的数据块，然后将其转发到 transformStream.readable。
    • chunk <any>
    • controller <TransformStreamDefaultController>
    • 返回：一个解析为 undefined 的 promise。
  • flush <Function> 一个用户定义的函数，在 TransformStream 的可写侧关闭之前立即调用，标志着转换过程的结束。
    • controller <TransformStreamDefaultController>
    • 返回：一个解析为 undefined 的 promise。
  • readableType <any> readableType 选项为将来使用保留，并且必须为 undefined。
  • writableType <any> writableType 选项为将来使用保留，并且必须为 undefined。
• writableStrategy <Object>
  • highWaterMark <number> 在施加背压之前的最大内部队列大小。
  • size <Function> 一个用户定义的函数，用于确定每个数据块的大小。
    • chunk <any>
    • 返回：<number>
• readableStrategy <Object>
  • highWaterMark <number> 在施加背压之前的最大内部队列大小。
  • size <Function> 一个用户定义的函数，用于确定每个数据块的大小。
    • chunk <any>
    • 返回：<number>

transformStream.readable#

• 类型: <ReadableStream>

transformStream.writable#

• 类型: <WritableStream>

使用 postMessage() 传输#

一个 <TransformStream> 实例可以使用 <MessagePort> 进行传输。

const stream = new TransformStream();

const { port1, port2 } = new MessageChannel();

port1.onmessage = ({ data }) => {
  const { writable, readable } = data;
  // ...
};

port2.postMessage(stream, [stream]); copy

transformStreamDefaultController.desiredSize#

• 类型：<number>

填满可读侧队列所需的数据量。

transformStreamDefaultController.enqueue([chunk])#

• chunk <any>

将一个数据块附加到可读侧的队列中。

transformStreamDefaultController.error([reason])#

• reason <any>

向可读和可写两侧发送信号，通知在处理转换数据时发生错误，导致两侧都被突然关闭。

transformStreamDefaultController.terminate()#

关闭传输的可读侧，并导致可写侧因错误而突然关闭。

new ByteLengthQueuingStrategy(init)#

• init <Object>
  • highWaterMark <number>

byteLengthQueuingStrategy.highWaterMark#

• 类型：<number>

byteLengthQueuingStrategy.size#

• 类型: <Function>
  • chunk <any>
  • 返回：<number>

new CountQueuingStrategy(init)#

• init <Object>
  • highWaterMark <number>

countQueuingStrategy.highWaterMark#

• 类型：<number>

countQueuingStrategy.size#

• 类型: <Function>
  • chunk <any>
  • 返回：<number>

new TextEncoderStream()#

创建一个新的 TextEncoderStream 实例。

textEncoderStream.encoding#

• 类型：<string>

TextEncoderStream 实例支持的编码。

textEncoderStream.readable#

• 类型: <ReadableStream>

textEncoderStream.writable#

• 类型: <WritableStream>

new TextDecoderStream([encoding[, options]])#

• encoding <string> 标识此 TextDecoder 实例支持的 encoding。默认值： 'utf-8'。
• options <Object>
  • fatal <boolean> 如果解码失败是致命的，则为 true。
  • ignoreBOM <boolean> 当为 true 时，TextDecoderStream 将在解码结果中包含字节顺序标记 (BOM)。当为 false 时，字节顺序标记将从输出中移除。此选项仅在 encoding 为 'utf-8'、'utf-16be' 或 'utf-16le' 时使用。默认值： false。

创建一个新的 TextDecoderStream 实例。

textDecoderStream.encoding#

• 类型：<string>

TextDecoderStream 实例支持的编码。

textDecoderStream.fatal#

• 类型：<boolean>

如果解码错误会导致抛出 TypeError，则该值为 true。

textDecoderStream.ignoreBOM#

• 类型：<boolean>

如果解码结果将包含字节顺序标记，则该值为 true。

textDecoderStream.readable#

• 类型: <ReadableStream>

textDecoderStream.writable#

• 类型: <WritableStream>

new CompressionStream(format)#

• format <string> 'deflate'、'deflate-raw'、'gzip' 或 'brotli' 之一。

compressionStream.readable#

• 类型: <ReadableStream>

compressionStream.writable#

• 类型: <WritableStream>

new DecompressionStream(format)#

• format <string> 'deflate'、'deflate-raw'、'gzip' 或 'brotli' 之一。

decompressionStream.readable#

• 类型: <ReadableStream>

decompressionStream.writable#

• 类型: <WritableStream>

streamConsumers.arrayBuffer(stream)#

• stream <ReadableStream> | <stream.Readable> | <AsyncIterator>
• 返回：<Promise> 解析为一个包含流完整内容的 ArrayBuffer。

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: 76const { arrayBuffer } = require('node:stream/consumers');
const { Readable } = require('node:stream');
const { TextEncoder } = require('node:util');

const encoder = new TextEncoder();
const dataArray = encoder.encode('hello world from consumers!');
const readable = Readable.from(dataArray);
arrayBuffer(readable).then((data) => {
  console.log(`from readable: ${data.byteLength}`);
  // Prints: from readable: 76
});copy

streamConsumers.blob(stream)#

• stream <ReadableStream> | <stream.Readable> | <AsyncIterator>
• 返回：<Promise> 解析为一个包含流完整内容的 <Blob>。

import { blob } from 'node:stream/consumers';

const dataBlob = new Blob(['hello world from consumers!']);

const readable = dataBlob.stream();
const data = await blob(readable);
console.log(`from readable: ${data.size}`);
// Prints: from readable: 27const { blob } = require('node:stream/consumers');

const dataBlob = new Blob(['hello world from consumers!']);

const readable = dataBlob.stream();
blob(readable).then((data) => {
  console.log(`from readable: ${data.size}`);
  // Prints: from readable: 27
});copy

streamConsumers.buffer(stream)#

• stream <ReadableStream> | <stream.Readable> | <AsyncIterator>
• 返回：<Promise> 解析为一个包含流完整内容的 <Buffer>。

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

const dataBuffer = Buffer.from('hello world from consumers!');

const readable = Readable.from(dataBuffer);
const data = await buffer(readable);
console.log(`from readable: ${data.length}`);
// Prints: from readable: 27const { buffer } = require('node:stream/consumers');
const { Readable } = require('node:stream');
const { Buffer } = require('node:buffer');

const dataBuffer = Buffer.from('hello world from consumers!');

const readable = Readable.from(dataBuffer);
buffer(readable).then((data) => {
  console.log(`from readable: ${data.length}`);
  // Prints: from readable: 27
});copy

streamConsumers.json(stream)#

• stream <ReadableStream> | <stream.Readable> | <AsyncIterator>
• 返回：<Promise> 解析为将流内容解析为 UTF-8 编码字符串，然后通过 JSON.parse() 处理后的结果。

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

const items = Array.from(
  {
    length: 100,
  },
  () => ({
    message: 'hello world from consumers!',
  }),
);

const readable = Readable.from(JSON.stringify(items));
const data = await json(readable);
console.log(`from readable: ${data.length}`);
// Prints: from readable: 100const { json } = require('node:stream/consumers');
const { Readable } = require('node:stream');

const items = Array.from(
  {
    length: 100,
  },
  () => ({
    message: 'hello world from consumers!',
  }),
);

const readable = Readable.from(JSON.stringify(items));
json(readable).then((data) => {
  console.log(`from readable: ${data.length}`);
  // Prints: from readable: 100
});copy

streamConsumers.text(stream)#

• stream <ReadableStream> | <stream.Readable> | <AsyncIterator>
• 返回：<Promise> 解析为将流内容解析为 UTF-8 编码字符串的结果。

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: 27const { text } = require('node:stream/consumers');
const { Readable } = require('node:stream');

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