【Node.js24.x】Object::readdir()メソッドの使い方
readdirメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
readdirメソッドは、指定されたディレクトリの内容を読み取ることを実行するメソッドです。このメソッドは、Node.jsにおけるファイルシステム操作の一部として提供されており、ディスク上の特定のフォルダにどのようなファイルやサブディレクトリが存在するかをプログラムから確認するために利用されます。
具体的には、パスとして指定されたディレクトリの中に含まれるすべてのエントリ（ファイル名やサブディレクトリ名）の一覧を配列として取得することができます。システムエンジニアを目指す初心者の方にとっては、例えばアプリケーションが特定のディレクトリに設定ファイルを保存しているかを確認したり、ユーザーがアップロードした画像ファイルの一覧を表示したりする際に、この機能が非常に役立ちます。
readdirメソッドは通常、非同期で動作するように設計されています。これは、ファイルやディレクトリの読み取りといったI/O処理は時間がかかる場合があり、その間にもプログラムの他の処理がブロックされずに実行され続けるようにするためです。処理結果はコールバック関数を通じて、またはPromiseオブジェクトを介して提供されます。これにより、効率的なプログラムの作成が可能となります。また、指定されたパスが存在しない場合やアクセス権がない場合など、ファイルシステム操作中に発生しうる様々なエラーを適切に処理する仕組みも備わっています。
このメソッドは、Node.jsアプリケーションがファイルやディレクトリと連携する上での基本的ながら重要な機能の一つです。
構文(syntax)
1import { promises as fs } from 'node:fs'; 2 3const directoryContents = await fs.readdir('./');
引数(parameters)
path, options, callback
- path: string: 読み込むディレクトリのパス
- options: object | undefined: 読み込みオプションを指定するオブジェクト
- callback: (err: NodeJS.ErrnoException | null, files: string[]) => void: 処理完了後に実行されるコールバック関数
戻り値(return)
戻り値なし
戻り値はありません