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

appendFileメソッドは、指定されたファイルに非同期でデータを追記するメソッドです。これは、Node.jsの標準ライブラリであるfs（ファイルシステム）モジュールによって提供される主要な機能の一つです。

このメソッドを使用すると、既存のファイルの内容を削除したり上書きしたりすることなく、新しいデータをファイルの末尾に追加できます。例えば、アプリケーションのログを記録する際や、既存のデータファイルに新しい情報を追加する際などに活用されます。

appendFileメソッドは非同期で動作するため、ファイルへのデータの追記中にプログラムの他の処理がブロックされることなく進行します。これにより、I/O操作によるアプリケーションの応答性低下を防ぎます。通常、引数として追記先のファイルパス、追記するデータ、オプション（文字エンコーディングなど）、そして処理結果を受け取るコールバック関数を指定します。操作が成功した場合はコールバック関数がエラーなしで呼び出され、エラーが発生した場合はコールバック関数の第一引数にエラーオブジェクトが渡されます。

また、Promiseを返すバージョンも用意されており、async/await構文と組み合わせて、より現代的で可読性の高い非同期処理を記述することも可能です。ファイル追記中にアクセス権の不足やファイルの存在しないなどのエラーが発生した場合に備え、適切なエラーハンドリングの実装が重要となります。

Copy
1const fs = require('node:fs/promises');
2
3async function appendToFileExample() {
4  try {
5    await fs.appendFile('example.txt', 'This is a new line to append.\n');
6    // ファイルへの追加が成功しました
7  } catch (err) {
8    // エラーが発生しました
9  }
10}
11
12appendToFileExample();

path, data, options, callback

• path: string: 追記するファイルのパス
• data: string | Buffer | Uint8Array: ファイルに追記するデータ
• options: object: オプション設定。encoding: string = 'utf8', mode: number = 0o666, flag: string = 'a'
• callback: function: ファイル追記処理完了後に実行されるコールバック関数

戻り値なし

戻り値はありません