fs.opendir

関数の概要

fs.opendirは、Node.jsのファイルシステムモジュールで提供される関数の1つです。この関数は、指定されたディレクトリを非同期で開き、そのディレクトリ内のファイルやサブディレクトリの情報を取得するために使用されます。

パラメータの説明

戻り値

fs.opendirは、Direntオブジェクトを含むディレクトリリーダを返します。この処理は非同期で行われます。

使用例

例1：指定ディレクトリを開いて中身を表示する

const { opendir } = require('fs').promises;

(async () => {
  const dir = await opendir('./my-directory');
  for await (const dirent of dir) {
    console.log(dirent.name);
  }
})();

例2：ディレクトリ内のファイルのパスを取得する

const { opendir } = require('fs').promises;

(async () => {
  const dir = await opendir('./my-directory');
  for await (const dirent of dir) {
    console.log(path.join('./my-directory', dirent.name));
  }
})();

関連する関数

• fs.readdir: ディレクトリ内のファイル名を取得する
• fs.stat: ファイルやディレクトリの状態（サイズ、更新日時など）を取得する

まとめ

fs.opendirは、指定されたディレクトリを非同期で開いて中身を取得するための関数です。取得したディレクトリリーダを使用して、ファイルやサブディレクトリなどの情報を簡単に取得できます。ただし、非同期処理であるため、コールバックやPromiseを適切に扱う必要があります。