JSPM

fs-find-root

2.0.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 913
  • Score
    100M100P100Q109188F
  • License MIT

search up directories

Package Exports

  • fs-find-root

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 (fs-find-root) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

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