find-up-simple
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

find-up-simple

Find a file or directory by walking up parent directories

This is a simpler version of my find-up package, now with zero dependencies.

Install

npm install find-up-simple

Usage

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

example.js

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

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

API

findUp(name, options?)

Returns a Promise for the found path or undefined if it could not be found.

findUpSync(name, options?)

Returns the found path or undefined if it could not be found.

name

Type: string

The name of the file or directory to find.

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 path to match.

stopAt

Type: URL | string
Default: Root directory

A directory path where the search halts if no matches are found before reaching this point.

FAQ

How is it different from find-up?

  • No support for multiple input names
  • No support for finding multiple paths
  • No custom matching
  • No symlink option
  • Zero dependencies
  • find-up - A more advanced version of this package
  • 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

Package Sidebar

Install

npm i find-up-simple

Weekly Downloads

1,067,737

Version

1.0.0

License

MIT

Unpacked Size

7.18 kB

Total Files

5

Last publish

Collaborators

  • sindresorhus