JSPM – find@0.1.5

Package Exports

find

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (find) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

#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)

find