【Node.js24.x】Object::clearLine()メソッドの使い方
clearLineメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
clearLineメソッドは、Node.jsの実行環境において、ターミナル（コンソール）の特定の行の内容をクリアする機能を実行するメソッドです。このメソッドは、主にコマンドラインインターフェース（CLI）アプリケーションで、動的な出力を制御するために利用されます。具体的には、画面に表示されている文字を消去し、新しい情報を表示するための準備を整えます。
例えば、ファイルのダウンロード進捗状況を示すバーや、長時間の処理におけるリアルタイムな進捗メッセージなど、表示内容が頻繁に更新される場面で非常に有用です。以前の表示をきれいに消去してから新しい情報を上書き表示することで、ユーザーは常に最新かつ整理された情報を視覚的に把握できるようになります。
このメソッドは、process.stdoutのような標準出力ストリームオブジェクトから呼び出されることが一般的です。引数として、カーソルを基準にして行のどの部分をクリアするか（例えば、カーソルの左側、右側、または行全体）を指定できます。これにより、開発者は表示内容をきめ細かく制御し、ユーザーに対してより分かりやすく、かつ混乱の少ない情報提供を実現することが可能です。非同期に動作するため、必要に応じてコールバック関数を渡して、クリア処理が完了したことを確認することもできます。
構文(syntax)
1const readline = require('readline'); 2readline.clearLine(process.stdout, 0);
引数(parameters)
stream, dir, callback
- stream: stream: 行をクリアする対象となるストリーム（通常は
process.stdout） - dir: string | undefined: 削除の方向を指定します。
'left'、'right'、またはundefined（行全体）を指定できます。 - callback: Function: 行がクリアされた後に呼び出されるコールバック関数
戻り値(return)
boolean
このメソッドは、指定されたストリームから現在の行をクリアできたかどうかを示す真偽値を返します。クリアに成功した場合は true を、失敗した場合は false を返します。