website/node_modules/read-pkg-up/readme.md

read-pkg-up Build Status

Read the closest package.json file

Why

Install

$ npm install --save read-pkg-up

Usage

var readPkgUp = require('read-pkg-up');

readPkgUp().then(function (result) {
    console.log(result);
    /*
    {
        pkg: {
            name: 'awesome-package',
            version: '1.0.0',
            ...
        },
        path: '/Users/sindresorhus/dev/awesome-package'
    }
    */
});

API

readPkgUp([options])

Returns a promise that resolves to a result object.

readPkgUp.sync([options])

Returns a result object.

options

cwd

Type: string Default: .

Directory to start looking for a package.json file.

normalize

Type: boolean Default: true

Normalize the package data.

Related

License

MIT © Sindre Sorhus



JohnCoene/chirp documentation built on May 25, 2021, 6:33 p.m.