Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Find files or directories by name
JavaScript
branch: master
Failed to load latest commit information.
test catch exceptions as far as possible
.gitignore ignore node_modules
LICENSE add a license
README.md docs
index.js wrap error handler
package.json update package

README.md

find

Find files or directories by name.

Installation

$ npm install find

Examples

Find all files in current directory.

var find = require('find');

find.file(__dirname, function(files) {
  console.log(files.length);
})

Filter by regular expression.

find.file(/\.js$/, __dirname, function(files) {
  console.log(files.length);
})

Features

  • Recursively search each sub-directories
  • Asynchronously or synchronously
  • Filtering by regular expression or string comparing

Changelog

0.2.0

  • the first pattern option is now optional
  • will follow symbolic links

API

#file([pattern], root, callback)

find.file(__dirname, function(files) {
  //
})

#dir([pattern], root, callback)

find.dir(__dirname, function(dirs) {
  //
})

#eachfile([pattern], root, action)

find.eachfile(__dirname, function(file) {
  //
})

#eachdir([pattern], root, action)

find.eachdir(__dirname, function(dir) {
  //
})

#fileSync([pattern], root)

var files = find.fileSync(__dirname);

#dirSync([pattern], root)

var dirs = find.dirSync(__dirname);

Returned object in Asynchronous APIs

Handling errors

find
  .file(__dirname, function(file) {
    //  
  })
  .error(function(err) {
    if (err) {
      //
    }
  })

Detect end in find.eachfile and find.eachdir

find
  .eachfile(__dirname, function(file) {
    //
  })
  .end(function() {
    console.log('find end'); 
  }) 

LICENSE

(MIT Licensed)

Something went wrong with that request. Please try again.