check-kit

Checks if a newer version is available for command line interfaces.

It is designed to be extremely easy to use and for CLI's that want to be in control.

What check-kit does:

• Checks if there is a new version available
• Checks version for a specific dist tag
• Fetches latest version from npm based on time interval
• Persists the update metadata
• Supports HTTP proxies

What check-kit does not do:

• Display a message when a new version is available, that's up to you how you want it formatted

Installation

npm install check-kit --save

Example

Basic usage:

import check from 'check-kit';

(async () => {
    const { current, distTag, name, latest, updateAvailable } = await check();

    console.log(`Current version of package ${name} is ${current}`);

    if (updateAvailable) {
        console.log(`There is a new version available! ${current} -> ${latest}`);
    } else {
        console.log(`Version ${current} is the latest`);
    }
})();

If you know where the package.json is, you can pass it in:

const result = await check({
    pkg: require('./package.json')
});

By default, check-kit will store update metadata in /tmp/check-kit directory. You can override the directory, but not the metadata filename, by passing in the metadata directory:

const result = await check({
    metaDir: `${os.homedir()}/myapp/update`
});

API

async check(opts)

Checks if the specified package has a newer version available.

opts and all options are optional.

Returns a Promise that resolves the following:

Metadata file

The metadata file contains information about the package and whether an update is available based on the last check.

You can override the directory where the metadata file is stored, but you cannot override the metadata filename. The filename is derived from the package name and the distribution tag. For example, the package @foo/bar would resolve the filename @foo-bar-latest.json.

Comparison

Legal

This project is open source under the Apache Public License v2 and is developed by Axway, Inc and the community. Please read the LICENSE file included in this distribution for more information.