Skip to content

rocktimsaikia/package-outdated

Repository files navigation

package-outdated build license

Returns the outdated packages of a package.json file.

Install

npm install package-outdated

Usage

const readOutdated = require('package-outdated')

(async()=>{
        console.log(await readOutdated());
        //=> {foo: { current: '1.0.0', latest: '2.0.0' }, ...}

       console.log(await readOutdated({ preservePrefix: true }));
       //=> {foo: { current: '^1.0.0', latest: '2.0.0' }, ...}
        
})();

API

readOutdated(options?)

Returns the outdated packages of a package.json file.

Options

dir

Type: string
Default: process.cwd()

Current working directory.

preservePrefix

Type: boolean
Default: false

Preserves the semver prefix(^*~) of the current version.

Realated

Support