JSPM

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

Find a file or directory by walking up parent directories

Package Exports

  • find-up
  • find-up/package

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

Readme

find-up Build Status: Linux and macOS Build Status: Windows

Find a file or directory by walking up parent directories

Install

$ npm install find-up

Usage

/
└── Users
        └── sindresorhus
                ├── unicorn.png
                └── foo
                        └── bar
                                ├── baz
                                └── example.js

example.js

const findUp = require('find-up');

(async () => {
    console.log(await findUp('unicorn.png'));
    //=> '/Users/sindresorhus/unicorn.png'

    console.log(await findUp(['rainbow.png', 'unicorn.png']));
    //=> '/Users/sindresorhus/unicorn.png'
})();

API

findUp(filename, [options])

Returns a Promise for either the filepath or null if it couldn't be found.

findUp([filenameA, filenameB], [options])

Returns a Promise for either the first filepath found (by respecting the order) or null if none could be found.

findUp.sync(filename, [options])

Returns a filepath or null.

findUp.sync([filenameA, filenameB], [options])

Returns the first filepath found (by respecting the order) or null.

filename

Type: string

Filename of the file to find.

options

Type: Object

cwd

Type: string
Default: process.cwd()

Directory to start from.

  • find-up-cli - CLI for this module
  • pkg-up - Find the closest package.json file
  • pkg-dir - Find the root directory of an npm package
  • resolve-from - Resolve the path of a module like require.resolve() but from a given path

License

MIT © Sindre Sorhus