関数の概要
stream.finishedとは、Node.jsのモジュールであり、ストリームの完了を監視するために使用されます。ストリームが終了した際にコールバック関数を実行することができます。
パラメータの説明
引数 | 型 | 用途 |
---|---|---|
stream | ReadableStream | WritableStream | 監視するストリーム |
callback | function | ストリームが完了したときに実行するコールバック関数 |
戻り値
戻り値はありません。stream.finishedは非同期関数であり、コールバック関数がストリームの完了時に実行されます。
使用例
ストリームが完了した時にログメッセージを表示する例:
const fs = require('fs');
const stream = fs.createReadStream('example.txt');
stream.on('error', (err) => console.error(err));
stream.finished(stream, () => {
console.log('ストリームが完了しました');
});
ストリームがエラーを起こした場合に処理を行う例:
stream.finished(stream, (err) => {
if (err) {
console.error('エラーが発生しました: ', err);
}
});
関連する関数
- stream.Readable: 読み取り可能なストリームを作成するためのクラス
- stream.Writable: 書き込み可能なストリームを作成するためのクラス
まとめ
stream.finishedはストリームの完了を監視するための便利な機能です。ストリームが終了した時に特定の処理を行いたい場合に活用できます。エラー処理も柔軟に行うことができます。