stream.Readable.pipe

関数の概要

stream.Readable.pipeは、Node.jsで使われる関数の一つです。この関数は、読み込み可能なストリームからデータを読み取り、それを書き込み可能なストリームに自動的に転送するためのメソッドです。つまり、ストリーム間でデータを簡単に転送する際に利用されます。

パラメータの説明

戻り値

pipeメソッドは、destinationと同じWritable Streamを返します。このメソッドは非同期で実行されます。

使用例

例1: ファイルから読み取ったデータを別のファイルに書き込む

const fs = require('fs');
const readableStream = fs.createReadStream('input.txt');
const writableStream = fs.createWriteStream('output.txt');
readableStream.pipe(writableStream);

例2: HTTPリクエストをHTTPレスポンスにパイプする

const http = require('http');
const server = http.createServer((req, res) => {
  const readableStream = fs.createReadStream('index.html');
  readableStream.pipe(res);
});
server.listen(3000);

関連する関数

・stream.Readable
・stream.Writable
・stream.Duplex

まとめ

stream.Readable.pipeは、ストリーム間でデータを簡単に転送するための便利なメソッドです。ただし、ストリーム同士の互換性やエラーハンドリングなどに注意する必要があります。