関数の概要
fs.fstatは、Node.jsのファイルシステムモジュール(fsモジュール)に含まれる関数です。この関数は、指定されたファイルの状態を取得するために使用されます。ファイルの情報(サイズ、作成日時、更新日時など)を取得することができます。
パラメータの説明
パラメータ | 型 | 用途 |
---|---|---|
fd | integer | ファイルの記述子(descriptor) |
callback | function | 非同期処理の完了後に呼び出されるコールバック関数 |
戻り値
fs.fstatの戻り値はfs.Statsオブジェクトです。このオブジェクトには、ファイルの状態に関する情報が含まれています。非同期処理であるため、コールバック関数内でこのオブジェクトを使用する必要があります。
使用例
以下に、fs.fstatの使用例を示します。
const fs = require('fs');
fs.open('file.txt', 'r', (err, fd) => {
if (err) throw err;
fs.fstat(fd, (err, stats) => {
if (err) throw err;
console.log(stats);
});
});
関連する関数
fs.fstatとよく一緒に使用される関数や似た役割を持つ関数として、fs.stat、fs.lstatなどがあります。
まとめ
fs.fstatは、指定されたファイルの状態を取得するための関数であり、ファイルの情報を取得する際に使用されます。非同期処理であるため、コールバック関数内で取得したファイル情報を扱うことに注意が必要です。