Node.js Stream readable.readableLength 属性

在 Node.js 中，Stream 是一种处理流数据的抽象接口，Stream 可以读取或写入数据流。readable 属性是 Node.js Stream 中的可读流（Readable Stream）的一个特定属性，它用于获取读取队列中当前可以从流中读取的数据的长度。

属性说明

readable.readableLength 属性返回当前可读流（Readable Stream）阅读器队列中可供读取的数据的字节长度。 [1]

它是 readable._readableState.length 和 readable._readableState.buffer.length 的和：

readable.readableLength = readable._readableState.length + readable._readableState.buffer.length;

readable._readableState.length 属性是可读流阅读器队列中缓冲的数据的字节长度。 readable._readableState.buffer.length 属性是可读流阅读器队列中缓存的数据的 buffer 数组的字节长度，包括所有缓存块的数据的长度之和。

类型

number

注意事项

通常情况下，我们无需直接使用 readable.readableLength 属性，因为可读流会自行管理其读取队列和阅读器缓冲，我们可以通过监听 'data' 事件来读取流数据。

然而，如果我们需要了解当前缓冲的数据量和数据块的数量，那么我们可以使用它。

另外，readableLength 可能不是一个实时准确的值，因为数据可能在阅读器队列和缓冲区之间移动。

示例

以下示例使用 readable.readableLength 属性来获取可读流（Readable Stream）中缓存的字节数:

const { Readable } = require('stream');

const rs = new Readable({
  read() {}
});

rs.push('Hello, ');
rs.push('world!');
rs.push(null);

console.log(`Total buffered bytes: ${rs.readableLength}`);
// Output: Total buffered bytes: 13

结论

Node.js Stream 中的 readable.readableLength 属性是用于获取读取队列中当前可以从流中读取的数据的长度的一个特定属性。它可以用于获知可读流（Readable Stream）阅读器队列中缓存的字节数，以及数据块的数量。通常情况下，我们无需直接使用此属性，因为可读流会自行管理其读取队列和阅读器缓冲，我们可以通过监听 'data' 事件来读取流数据。