Popularity
4.3
Growing
Activity
4.7
-
564
11
49

Code Quality Rank: L5
Monthly Downloads: 0
Programming language: JavaScript
License: MIT License
Tags: Search     Filesystem     Path     Match     File     Find     Package     Directory     Folder     Dir     Walk     Walking     Parents     Parent     Resolve     Look     Look-up     Findup     Find-up     Up    
Latest version: v5.0.0

find-up alternatives and similar modules

Based on the "Filesystem" category.
Alternatively, view find-up alternatives based on common mentions on social networks and blogs.

Do you think we are missing an alternative of find-up or a related project?

Add another 'Filesystem' Module

README

find-up

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

import path from 'node:path';
import {findUp, pathExists} from 'find-up';

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 pathExists(path.join(directory, 'unicorn.png'));
    return hasUnicorns && directory;
}, {type: 'directory'}));
//=> '/Users/sindresorhus'

API

findUp(name, options?)

findUp(matcher, options?)

Returns a Promise for either the path or undefined if it couldn't be found.

findUp([...name], options?)

Returns a Promise for either the first path found (by respecting the order of the array) or undefined if none could be found.

findUpMultiple(name, options?)

findUpMultiple(matcher, options?)

Returns a Promise for either an array of paths or an empty array if none could be found.

findUpMultiple([...name], options?)

Returns a Promise for either an array of the first paths found (by respecting the order of the array) or an empty array if none could be found.

findUpSync(name, options?)

findUpSync(matcher, options?)

Returns a path or undefined if it couldn't be found.

findUpSync([...name], options?)

Returns the first path found (by respecting the order of the array) or undefined if none could be found.

findUpMultipleSync(name, options?)

findUpMultipleSync(matcher, options?)

Returns an array of paths or an empty array if none could be found.

findUpMultipleSync([...name], options?)

Returns an array of the first paths found (by respecting the order of the array) or an empty array if none could be found.

name

Type: string

The name of the file or directory to find.

matcher

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.

options

Type: object

cwd

Type: URL | string\ Default: process.cwd()

The directory to start from.

type

Type: string\ Default: 'file'\ Values: 'file' 'directory'

The type of paths that can match.

allowSymlinks

Type: boolean\ Default: true

Allow symbolic links to match if they point to the chosen path type.

stopAt

Type: string\ Default: path.parse(cwd).root

The path to the directory to stop the search before reaching root if there were no matches before the stopAt directory.

pathExists(path)

Returns a Promise<boolean> of whether the path exists.

pathExistsSync(path)

Returns a boolean of whether the path exists.

path

Type: string

The path to a file or directory.

findUpStop

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.

import path from 'node:path';
import {findUp, findUpStop} from 'find-up';

await findUp(directory => {
    return path.basename(directory) === 'work' ? findUpStop : 'logo.png';
});

Related

  • 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

Get professional support for 'find-up' with a Tidelift subscription Tidelift helps make open source sustainable for maintainers while giving companiesassurances about security, maintenance, and licensing for their dependencies.