Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

【Node.js24.x】Stream::promisesプロパティの使い方

promisesプロパティの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

promisesプロパティは、Node.jsのStreamモジュールにおいて、ストリーム操作をPromiseベースで扱うためのユーティリティへのアクセスを提供するプロパティです。Node.jsでは、ファイル読み書きやネットワーク通信など、大量のデータを効率的に処理するためにストリームという仕組みが広く利用されています。従来のストリームAPIは、データの流れをイベントやコールバック関数で処理することが多く、複数の非同期処理が絡むとコードの可読性やエラーハンドリングが複雑になる傾向がありました。

このpromisesプロパティを利用することで、ストリーム関連の非同期操作をPromiseとして扱うことが可能になります。これにより、JavaScriptのasync/await構文と組み合わせて、ストリームの読み書き、変換、結合といった処理を、より直線的で理解しやすいコードで記述できるようになります。例えば、stream.promises.pipeline()を使って複数のストリームを順に連結し、データ処理の完了やエラーをPromiseで一括して処理したり、stream.promises.finished()でストリームが完全に終了するのを待機したりすることができます。このプロパティは、モダンな非同期プログラミングスタイルでNode.jsのストリームを効果的に扱うための重要な入り口となります。

構文(syntax)

1import { pipeline, finished } from 'node:stream/promises';

引数(parameters)

引数なし

引数はありません

戻り値(return)

戻り値なし

戻り値はありません

関連コンテンツ