find

Find files or directories by name

npm install find
114 downloads in the last day
578 downloads in the last week
2 807 downloads in the last month

find

Find files or directories by name.

Installation

$ npm install find

Examples

Find all .js files in current directory.

var find = require('find');

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

API

#file(pattern, root, callback)

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

#dir(pattern, root, callback)

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

#eachfile(pattern, root, action)

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

#eachdir(pattern, root, callback)

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)

npm loves you