fs-find-root

search up directories

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
fs-find-root
2.0.08 years ago10 years agoMinified + gzip package size for fs-find-root in KB

Readme

fs-find-root
Build Status npm install npm version js-standard-style License
search up directories until you find what you're looking for

usage

var find = require('fs-find-root')
  • find('dir', name, startingDirectory) searches for directory
name starting from startDirectory and returns a promise.
  • find.dir(name, startingDirectory) is equivalent to the above.
  • find('file', name, startingDirectory) searches for file name
starting from startDirectory and returns a promise.
  • find.file(name, startingDirectory) is equivalent to the above.

example

var find = require('fs-find-root')

// find a directory!
find.dir('.git', process.cwd())
  .then(function (found) {
    console.log('found the root of your git repo @ ' + found)
  })

// find a file!
find.file('package.json', process.cwd())
  .then(function (found) {
    console.log('found yer package.json right here: ' + found)
  })

notes

  • resolves with null if the file or directory is not found.

license

MIT