stream.Readable.unpipe

関数の概要

stream.Readable.unpipeとは、ストリームからパイプ接続を解除するための関数です。パイプ接続とは、ストリーム間でデータの受け渡しを行う仕組みであり、unpipeを使うことでその接続を解除することができます。

パラメータの説明

パラメータ 用途
destination Writable 接続を解除するWritableストリーム

戻り値

戻り値は特になく、undefinedが返されます。非同期で動作します。

使用例


const fs = require('fs');
const stream = fs.createReadStream('input.txt');
const dest = fs.createWriteStream('output.txt');

stream.pipe(dest);

stream.unpipe(dest);

関連する関数

stream.Readable.pipe: ストリーム間でデータの受け渡しを行う際に使用する

まとめ

stream.Readable.unpipeは、ストリーム間のパイプ接続を解除するための関数であり、データの受け渡しを制御する際に利用されます。注意点として、unpipeを呼ぶことで接続が解除されるため、データが正しく処理されるように注意する必要があります。