recursive-readdir

WebJar for recursive-readdir

License

License

MIT
GroupId

GroupId

org.webjars.npm
ArtifactId

ArtifactId

recursive-readdir
Last Version

Last Version

2.2.2
Release Date

Release Date

Type

Type

jar
Description

Description

recursive-readdir
WebJar for recursive-readdir
Project URL

Project URL

http://webjars.org
Source Code Management

Source Code Management

https://github.com/jergason/recursive-readdir

Download recursive-readdir

How to add to project

<!-- https://jarcasting.com/artifacts/org.webjars.npm/recursive-readdir/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>recursive-readdir</artifactId>
    <version>2.2.2</version>
</dependency>
// https://jarcasting.com/artifacts/org.webjars.npm/recursive-readdir/
implementation 'org.webjars.npm:recursive-readdir:2.2.2'
// https://jarcasting.com/artifacts/org.webjars.npm/recursive-readdir/
implementation ("org.webjars.npm:recursive-readdir:2.2.2")
'org.webjars.npm:recursive-readdir:jar:2.2.2'
<dependency org="org.webjars.npm" name="recursive-readdir" rev="2.2.2">
  <artifact name="recursive-readdir" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.webjars.npm', module='recursive-readdir', version='2.2.2')
)
libraryDependencies += "org.webjars.npm" % "recursive-readdir" % "2.2.2"
[org.webjars.npm/recursive-readdir "2.2.2"]

Dependencies

compile (1)

Group / Artifact Type Version
org.webjars.npm : minimatch jar [3.0.4]

Project Modules

There are no modules declared in this project.

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.

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

recursive("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.

Versions

Version
2.2.2
2.2.1