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

fstatメソッドは、Node.jsの環境において、指定されたファイル記述子に関連付けられたファイルの詳細な統計情報を取得するメソッドです。このメソッドを利用することで、プログラムからファイルの現在の状態を正確に把握できます。具体的には、ファイルのサイズ、最終更新日時、最終アクセス日時、作成日時、ファイルのモード（パーミッション）、デバイスID、inode番号、ハードリンク数、ファイルの所有者（UIDおよびGID）など、多岐にわたるメタデータ（付帯情報）を取得することが可能です。

ファイル記述子は、オペレーティングシステムがファイルを識別するために使用する整数値で、ファイルを開いた際にOSから提供されます。fstatメソッドは、このファイル記述子を介して、ファイルの内容ではなく、そのファイルの「属性」に関する情報だけを取得します。

システムエンジニアを目指す方にとって、この機能はファイルシステムを扱う上で非常に重要です。例えば、ファイルのサイズをチェックしてディスク容量の管理に役立てたり、ファイルの最終更新日時を比較して変更があったかどうかを判断し、キャッシュの更新やバックアップ処理のトリガーにしたりする際に活用されます。また、ファイルのパーミッション情報を取得することで、セキュリティ上のアクセス制御が適切に行われているかを確認することも可能です。Node.jsでは、非同期操作をサポートしており、ファイルの統計情報を効率的かつノンブロッキングに取得できるため、大規模なアプリケーションにおいてもパフォーマンスを損なうことなく利用できます。

Copy
1const fs = require('node:fs/promises');
2
3async function exampleFstatSyntax() {
4  let fileHandle;
5  try {
6    fileHandle = await fs.open('example.txt', 'w+');
7
8    // fstat の構文
9    const stats = await fs.fstat(fileHandle.fd);
10    // stats オブジェクトには、ファイルサイズ、最終変更日時などの統計情報が含まれます。
11
12  } finally {
13    if (fileHandle) {
14      await fileHandle.close();
15    }
16  }
17}

fd, options = {bigint: false}, callback

• fd: number: stat 情報を取得するファイルディスクリプタ
• options: object = {bigint: false}: オプションを指定するオブジェクト。
• callback: Function: 処理完了後に実行されるコールバック関数。

戻り値なし

戻り値はありません