【JavaScript】readdirSyncメソッドとは

readdirSyncメソッドとは

readdirSync メソッドは、Node.js の fs モジュールに含まれる同期的なファイルシステム操作メソッドの一つです。このメソッドは、指定されたディレクトリ内のファイルおよびサブディレクトリのリストを同期的に取得します。

使用方法

以下は readdirSync メソッドの基本的な使用法です：

const fs = require('fs');

try {
  // 指定されたディレクトリ内のファイルおよびサブディレクトリのリストを取得
  const files = fs.readdirSync('/path/to/directory');
  console.log(files); // ファイルおよびディレクトリのリストを出力
} catch (err) {
  console.error('Error reading directory:', err);
}

readdirSync メソッドは指定されたディレクトリ内のエントリの名前を配列として返します。ディレクトリ内のエントリがサブディレクトリやファイルである場合、その名前が配列の要素として含まれます。

まとめ

このメソッドは同期的に実行されるため、ファイルシステムの操作が完了するまで次の処理はブロックされます。大規模なファイルシステムや大量のファイルがある場合、同期的なメソッドの使用には注意が必要です。非同期的なメソッドを選択するか、同期的なメソッドを非同期的な方法で使用することが推奨されます。