fs.readdir

関数の概要

fs.readdirとは、Node.jsにおけるファイルシステムモジュールの一部であり、指定されたディレクトリ内のファイルやディレクトリの一覧を取得するための関数です。主な目的は、指定されたディレクトリ内に何が存在するのかを調べたり、ファイルやディレクトリを操作する際に利用されます。

パラメータの説明

引数 型 用途
path String ディレクトリのパスを指定する
options Object (省略可能) オプション設定を指定する（例: エンコーディング）

戻り値

fs.readdirは非同期処理であり、コールバック関数を使用して取得したファイルやディレクトリの一覧を返します。返り値は配列であり、指定されたディレクトリ内のファイルやディレクトリ名が含まれます。

使用例

以下にfs.readdirの使用例を示します。


const fs = require('fs');

fs.readdir('./my-directory', (err, files) => {
  if (err) throw err;
  console.log('Directory listing:', files);
});

関連する関数

  • fs.readFile: ファイルを非同期で読み込む
  • fs.writeFileSync: ファイルを同期的に書き込む

まとめ

fs.readdirは指定されたディレクトリ内のファイルやディレクトリを取得する際に便利な関数です。非同期処理であるため、コールバック関数を使用して結果を取得する必要があります。ディレクトリが大きい場合やファイルの数が多い場合には、処理時間に注意が必要です。

スポンサーリンク