関数の概要
fs.statは、Node.jsでファイルやディレクトリの状態(存在、サイズ、更新日時など)を取得するための関数です。ファイルの存在確認や情報取得など、ファイルシステムの操作において重要な役割を果たします。
パラメータの説明
パラメータ | 型 | 用途 |
---|---|---|
path | string | ファイルパスを指定する |
callback | function | 処理完了後に呼び出されるコールバック関数を指定 |
戻り値
fs.statは非同期関数であり、引数で指定したパスに対するファイルやディレクトリの状態を取得し、コールバック関数にその情報を渡します。
使用例
ファイルの存在確認:
const fs = require('fs');
fs.stat('./file.txt', (err, stats) => {
if (err) {
console.error(err);
return;
}
console.log(stats);
});
ファイルのサイズ取得:
const fs = require('fs');
fs.stat('./file.txt', (err, stats) => {
if (err) {
console.error(err);
return;
}
console.log('File size: ' + stats.size + ' bytes');
});
関連する関数
fs.readdir, fs.access, fs.unlink
まとめ
fs.statはファイルやディレクトリの状態を取得するための重要な関数です。非同期処理であるため、コールバック関数を通じて情報を取得できます。ファイル操作において欠かせない関数の一つであるため、理解しておくと便利です。