【Node.js24.x】Object::statfsSync()メソッドの使い方
statfsSyncメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
statfsSyncメソッドは、指定されたパスが属するファイルシステムの統計情報を同期的に取得するメソッドです。このメソッドを利用することで、例えば、ディスクの総容量、利用可能な空き容量、ファイルシステムのブロックサイズ、そして使用可能なinode（ファイルやディレクトリのメタデータを管理するための構造）の数など、ファイルシステムの「健康状態」を示すさまざまな情報を一度に取得できます。
このメソッドは「Sync」の名前が示す通り、同期処理を行います。つまり、ファイルシステムの統計情報の取得が完了するまで、Node.jsのイベントループがブロックされ、他のJavaScriptコードの実行が一時停止します。そのため、アプリケーションの応答性が重要となるメインスレッドでの利用には注意が必要ですが、スクリプトの起動時やユーティリティツールなど、処理の完了を待っても問題ない場面で手軽に利用できます。
取得した情報はオブジェクトとして返され、システムエンジニアがディスクの使用状況を監視したり、アプリケーションが必要とするストレージ容量が利用可能かを確認したりする際に役立ちます。例えば、特定のディレクトリが含まれるディスクの残容量が不足していないかを事前にチェックするといった用途に活用できます。このメソッドは、Node.js環境でファイルシステムの状態を把握し、安定したシステム運用に貢献するための重要な機能を提供します。
構文(syntax)
1const fs = require('node:fs'); 2 3try { 4 const stats = fs.statfsSync('/'); 5 console.log(stats); 6} catch (err) { 7 console.error('Failed to get file system stats:', err); 8}
引数(parameters)
path, options={bigint:false}
- path: string: statfsSyncを実行するファイルのパス
- options: object = {bigint:false}: オプションを指定するオブジェクト
- bigint: boolean = false: trueに設定すると、ファイルシステムの統計情報がBigInt型で返されます。
戻り値(return)
fs.StatsFsオブジェクト
fs.StatsFs オブジェクトが返されます。このオブジェクトには、ファイルシステムに関する統計情報（ブロックサイズ、総ブロック数、使用可能ブロック数など）が含まれています。