recursive-readdir
Get an array of all files in a directory and subdirectories.
Last updated 2 years ago by jergason .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install recursive-readdir 
SYNC missed versions from official npm registry.

recursive-readdir

Build Status

Recursively list all files in a directory and its subdirectories. It does not list the directories themselves.

Because it uses fs.readdir, which calls readdir under the hood on OS X and Linux, the order of files inside directories is not guaranteed.

Installation

npm install recursive-readdir

Usage

var recursive = require("recursive-readdir");

recursive("some/path", function (err, files) {
  // `files` is an array of file paths
  console.log(files);
});

It can also take a list of files to ignore.

var recursive = require("recursive-readdir");

// ignore files named "foo.cs" or files that end in ".html".
recursive("some/path", ["foo.cs", "*.html"], function (err, files) {
  console.log(files);
});

You can also pass functions which are called to determine whether or not to ignore a file:

var recursive = require("recursive-readdir");

function ignoreFunc(file, stats) {
  // `file` is the path to the file, and `stats` is an `fs.Stats`
  // object returned from `fs.lstat()`.
  return stats.isDirectory() && path.basename(file) == "test";
}

// Ignore files named "foo.cs" and descendants of directories named test
recursive("some/path", ["foo.cs", ignoreFunc], function (err, files) {
  console.log(files);
});

Promises

You can omit the callback and return a promise instead.

readdir("some/path").then(
  function(files) {
    console.log("files are", files);
  },
  function(error) {
    console.error("something exploded", error);
  }
);

The ignore strings support Glob syntax via minimatch.

Current Tags

  • 2.2.2                                ...           latest (2 years ago)

15 Versions

  • 2.2.2                                ...           2 years ago
  • 2.2.1                                ...           3 years ago
  • 2.1.1                                ...           3 years ago
  • 2.1.0                                ...           3 years ago
  • 2.0.0                                ...           4 years ago
  • 1.3.0                                ...           4 years ago
  • 1.2.1                                ...           5 years ago
  • 1.2.0                                ...           5 years ago
  • 1.1.3                                ...           5 years ago
  • 1.1.2                                ...           5 years ago
  • 1.1.1                                ...           6 years ago
  • 1.1.0                                ...           6 years ago
  • 1.0.0                                ...           6 years ago
  • 0.0.2                                ...           6 years ago
  • 0.0.1                                ...           8 years ago
Maintainers (1)
Downloads
Today 363
This Week 33,045
This Month 73,858
Last Day 5,800
Last Week 38,587
Last Month 157,781
Dependencies (1)
Dev Dependencies (1)
Dependents (1600)

Copyright 2014 - 2016 © taobao.org |