Help us understand the problem. What are the problem?

More than 3 years have passed since last update.

posted at

特定ディレクトリ配下のファイルのみ(またはディレクトリのみ)を取得(Node.js v10.10以降版)

Node.js で特定ディレクトリ配下のファイルのみ(またはディレクトリのみ)を取得するには、以前は特定ディレクトリ配下のリストを取得して、1つずつ fs.stat でファイルか否か判定する必要がありました。
しかし、Node.js v10.10.0 で新たに追加されたオプションによってちょっとだけ簡単に書けるようになりました。


fs.readdir または fs.readdirSync のオプションで withFileTypes: true を指定する。

以下のサンプルは、特定ディレクトリ配下のファイルのみを取得するコードですが、ディレクトリのみを取得する場合も同様で stat.isDirectory()dirent.isDirectory() とするだけです。
また、コードの読みやすさのために同期版API( fs.readdirSync など)を使用していますが、非同期版APIでも同じです。

Node.js v10.10 より前の書き方

const fs = require("fs");

const isFile = path => {
  const stat = fs.statSync(path);
  return stat.isFile();

const dirPath = "path/to/target";

// "path/to/target" 直下のファイルやディレクトリ名全てが文字列の配列で返ってくる
const allNames = fs.readdirSync(dirPath);

const fileNames = allNames.filter(name => isFile(`${dirPath}/${name}`))  

Node.js v10.10 以降でのちょっと簡単な書き方

const fs = require("fs");

const dirPath = "path/to/target";

// "path/to/target" 直下のファイルやディレクトリ全てがDirentオブジェクトの配列で返ってくる
const allDirents = fs.readdirSync(dirPath, { withFileTypes: true });

const fileNames = allDirents.filter(dirent => dirent.isFile()).map(({ name }) => name);
  • withFileTypes のデフォルト値は false のため、何も指定しない場合は従来と同じ挙動となります。
  • withFileTypes: true を指定すると、戻り値の型がDirentオブジェクトの配列に変わります。


Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
Help us understand the problem. What are the problem?