関数の概要
fs.promises.statは、Node.jsのFile Systemモジュール(fs)において、ファイルやディレクトリの情報を取得するための関数です。この関数を使用することで、指定したパスのファイルやディレクトリの情報(サイズ、更新日時、所有者など)を非同期的に取得することができます。
パラメータの説明
引数 | 型 | 用途 |
---|---|---|
path | string | ファイルパスまたはディレクトリパスを指定する |
戻り値
戻り値はPromiseオブジェクトとなり、非同期的にファイルまたはディレクトリの情報を含むfs.Statsオブジェクトを返します。
使用例
ファイルの情報を取得する例:
const fs = require('fs').promises;
fs.stat('file.txt')
.then((stats) => {
console.log(stats);
})
.catch((err) => {
console.error(err);
});
ディレクトリの情報を取得する例:
const fs = require('fs').promises;
fs.stat('directory')
.then((stats) => {
console.log(stats);
})
.catch((err) => {
console.error(err);
});
関連する関数
関連する関数として、fs.promises.readdirやfs.promises.writeFileなどがあります。これらの関数もファイルシステムの操作を行う際に役立ちます。
まとめ
fs.promises.statを使用することで、指定したパスのファイルやディレクトリの情報を非同期的に取得できます。注意点として、パスが存在しない場合やアクセス権がない場合など、エラーが発生する可能性があるため、適切にエラーハンドリングを行うことが重要です。