【Node.js24.x】Object::writeFile()メソッドの使い方

writeFileメソッドは、Node.jsのファイルシステム操作を担うObjectクラスのメソッドの一つで、指定されたファイルにデータを非同期で書き込みます。このメソッドは、書き込むファイルのパス、データ本体、オプション設定、そして処理完了後に呼び出されるコールバック関数を引数に取ります。

具体的には、第一引数で指定されたパスに、第二引数のデータを書き込みます。対象のファイルが存在しない場合は新規作成され、データが格納されます。ファイルが既に存在していれば、その内容は全て新しいデータで上書きされます。そのため、既存のファイルに内容を追記したい場合は、別のファイル操作メソッドを利用してください。

このメソッドの重要な特徴は、非同期処理であることです。ファイルへの書き込みはI/O操作であり時間がかかりますが、writeFileは処理開始後すぐに制御を返し、他の処理をブロックしません。書き込みが完了した際やエラー発生時には、引数で渡されたコールバック関数が実行され、結果が通知されます。システムエンジニアを目指す上では、非同期処理とエラーハンドリングの理解が重要です。

Copy
1import { writeFile } from 'node:fs/promises';
2
3async function writeExample() {
4  try {
5    await writeFile('example.txt', 'This is the content to be written.');
6  } catch (error) {
7    console.error(error);
8  }
9}
10
11writeExample();

path, data, options, callback

• path: string: 書き込むファイルのパスを指定します。
• data: string | Buffer | Uint8Array | object: ファイルに書き込むデータです。文字列、バッファ、またはUint8Arrayを指定できます。オブジェクトの場合、JSON.stringify()されて書き込まれます。
• options: object | string = null: ファイルの書き込みオプションを指定します。エンコーディング、モード、フラグなどを設定できます。
• callback: Function: ファイルの書き込みが完了した後に呼び出されるコールバック関数です。エラーが発生した場合は、エラーオブジェクトが渡されます。

戻り値なし

戻り値はありません