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

    4.0.0 • Public • Published

    pkg-up

    Find the closest package.json file

    Install

    npm install pkg-up

    Usage

    /
    └── Users
        └── sindresorhus
            └── foo
                ├── package.json
                └── bar
                    ├── baz
                    └── example.js
    
    // example.js
    import {pkgUp} from 'pkg-up';
    
    console.log(await pkgUp());
    //=> '/Users/sindresorhus/foo/package.json'

    API

    pkgUp(options?)

    Returns a Promise<string> for the file path, or Promise<undefined> if it could not be found.

    pkgUpSync(options?)

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

    options

    Type: object

    cwd

    Type: string
    Default: process.cwd()

    The directory to start from.

    Related

    • read-pkg-up - Read the closest package.json file
    • pkg-dir - Find the root directory of an npm package
    • find-up - Find a file by walking up parent directories

    Install

    npm i pkg-up

    DownloadsWeekly Downloads

    8,897,309

    Version

    4.0.0

    License

    MIT

    Unpacked Size

    4.5 kB

    Total Files

    5

    Last publish

    Collaborators

    • sindresorhus