peach a19a732be8 commit message | 2 anni fa | |
---|---|---|
.. | ||
index.d.ts | 2 anni fa | |
index.js | 2 anni fa | |
license | 2 anni fa | |
package.json | 2 anni fa | |
readme.md | 2 anni fa |
Find a file or directory by walking up parent directories
$ npm install find-up
/
└── Users
└── sindresorhus
├── unicorn.png
└── foo
└── bar
├── baz
└── example.js
example.js
const path = require('path');
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'
console.log(await findUp(async directory => {
const hasUnicorns = await findUp.exists(path.join(directory, 'unicorn.png'));
return hasUnicorns && directory;
}, {type: 'directory'}));
//=> '/Users/sindresorhus'
})();
Returns a Promise
for either the path or undefined
if it couldn't be found.
Returns a Promise
for either the first path found (by respecting the order of the array) or undefined
if none could be found.
Returns a path or undefined
if it couldn't be found.
Returns the first path found (by respecting the order of the array) or undefined
if none could be found.
Type: string
Name of the file or directory to find.
Type: Function
A function that will be called with each directory until it returns a string
with the path, which stops the search, or the root directory has been reached and nothing was found. Useful if you want to match files with certain patterns, set of permissions, or other advanced use-cases.
When using async mode, the matcher
may optionally be an async or promise-returning function that returns the path.
Type: object
Type: string
Default: process.cwd()
Directory to start from.
Type: string
Default: 'file'
Values: 'file'
'directory'
The type of paths that can match.
Type: boolean
Default: true
Allow symbolic links to match if they point to the chosen path type.
Returns a Promise<boolean>
of whether the path exists.
Returns a boolean
of whether the path exists.
Type: string
Path to a file or directory.
A Symbol
that can be returned by a matcher
function to stop the search and cause findUp
to immediately return undefined
. Useful as a performance optimization in case the current working directory is deeply nested in the filesystem.
const path = require('path');
const findUp = require('find-up');
(async () => {
await findUp(directory => {
return path.basename(directory) === 'work' ? findUp.stop : 'logo.png';
});
})();
require.resolve()
but from a given path