"Fossies" - the Fresh Open Source Software Archive

Member "node-v12.18.4-win-x86/node_modules/npm/node_modules/find-up/readme.md" (14 Feb 2020, 1910 Bytes) of package /windows/www/node-v12.18.4-win-x86.zip:


As a special service "Fossies" has tried to format the requested source page into HTML format (assuming markdown format). Alternatively you can here view or download the uninterpreted source code file. A member file download can also be achieved by clicking within a package contents listing on the according byte size field.

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

Find a file by walking up parent directories

Install

$ npm install --save find-up

Usage

/
└── Users
        └── sindresorhus
                ├── unicorn.png
                └── foo
                        └── bar
                                ├── baz
                                └── example.js
// example.js
const findUp = require('find-up');

findUp('unicorn.png').then(filepath => {
    console.log(filepath);
    //=> '/Users/sindresorhus/unicorn.png'
});

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

API

findUp(filename, options)

Returns a Promise for the filepath or null.

findUp([filenameA, filenameB], options)

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

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

cwd

Type: string
Default: process.cwd()

Directory to start from.

License

MIT © Sindre Sorhus