Nominally Patriotic Meathead
    Have ideas to improve npm?Join in the discussion! »

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

    3.1.0 • Public • Published

    pkg-up Build Status

    Find the closest package.json file

    Install

    $ npm install pkg-up
    

    Usage

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

    API

    pkgUp([options])

    Returns a Promise<string> for the filepath, or Promise<null> if it couldn't be found.

    pkgUp.sync([options])

    Returns the filepath, or null if it couldn't be found.

    options

    Type: Object

    cwd

    Type: string
    Default: process.cwd()

    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

    License

    MIT © Sindre Sorhus

    Install

    npm i pkg-up

    DownloadsWeekly Downloads

    7,909,046

    Version

    3.1.0

    License

    MIT

    Unpacked Size

    4.25 kB

    Total Files

    5

    Last publish

    Collaborators

    • avatar