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

statメソッドは、JavaScriptのオブジェクトに関する統計情報を取得するメソッドです。このメソッドは、指定されたオブジェクトの現在の状態、例えばプロパティの数、型の情報、メモリ利用に関する概要などを収集し、詳細な統計情報オブジェクトとして提供します。これにより、オブジェクトのランタイムにおける特性やリソース消費状況を把握することができます。

システムエンジニアを目指す初心者の方にとって、アプリケーション内でオブジェクトがどのように振る舞い、どのようなリソースを使用しているかを理解することは重要です。statメソッドは、特定のオブジェクトが持つプロパティの総数や、プロパティの列挙可能性、設定可能性、書き込み可能性といったメタデータ、さらにはオブジェクトが保持するデータの概算サイズなどの情報を提供する可能性があります。

このメソッドは、デバッグやパフォーマンスチューニングの際に、オブジェクトの状態をプログラム的に監視し、分析するための強力なツールとなり得ます。例えば、特定のオブジェクトが予想以上に多くのプロパティを持っている場合や、不要なメモリを消費している可能性を検知するのに役立ちます。返される統計情報オブジェクトには、プロパティのカテゴリ別カウントや、オブジェクトの内部構造に関する詳細が含まれることが期待されます。

注意点として、このメソッドはオブジェクトの動的な状態を反映するため、呼び出し時点でのスナップショットを提供します。そのため、オブジェクトが変更されると、再度呼び出すことで最新の統計情報を取得する必要があります。

Copy
1import * as fs from 'node:fs/promises';
2
3// Asynchronously retrieves file or directory statistics.
4// The `stats` object contains various information like size,
5// creation time, and methods such as `isFile()` or `isDirectory()`.
6const stats = await fs.stat('path/to/your/file_or_directory');

path, options, callback

• path: string: ファイルまたはディレクトリのパス
• options: object = { bigintLabels: false, throwIfFileExists: false, throwIfSymbolicLink: false, bigint: false }: オプションを指定するオブジェクト
• callback: function: 処理完了後に実行されるコールバック関数。引数としてエラーオブジェクト（err）とファイルステータスオブジェクト（stats）を受け取ります。

戻り値なし

戻り値はありません