compare-versions

What is compare-versions?

The compare-versions npm package is used to compare and sort semantic version numbers. It provides a simple API for comparing version strings in 'major.minor.patch' format, and it can be used in various environments such as Node.js, browsers, and as a command-line tool.

What are compare-versions's main functionalities?

Compare versions

Compares two semantic version numbers and returns -1, 0, or 1 if the first version is less than, equal to, or greater than the second version, respectively.

const compareVersions = require('compare-versions');
console.log(compareVersions('1.2.3', '4.11.6')); // -1

Check if a version satisfies a range

Determines if a version satisfies a given range. It returns true if the version meets the criteria of the range, false otherwise.

const compareVersions = require('compare-versions');
console.log(compareVersions.satisfies('1.2.3', '>=1.0.0')); // true

Sort an array of versions

Sorts an array of semantic version numbers in ascending order.

const compareVersions = require('compare-versions');
const versions = ['1.2.3', '4.11.6', '2.0.0'];
versions.sort(compareVersions);
console.log(versions); // ['1.2.3', '2.0.0', '4.11.6']

Other packages similar to compare-versions

semver

semver is a popular package that provides a wide range of functions for manipulating and comparing semantic versions. It is more feature-rich than compare-versions, offering functions like coercion, ranges, and prerelease comparisons.

node-version-compare

node-version-compare is another package for comparing version numbers. It is less popular and has a simpler API compared to compare-versions, focusing mainly on the comparison of version strings without additional features like range checking.

README

compare-versions

Compare semver version strings to find which is greater, equal or lesser. Runs in the browser as well as node.js/iojs.

Install

$ bower install compare-versions --save

Usage

var compareVersions = require('compare-versions');

compareVersions('10.1.8', '10.0.4'); //  1
compareVersions('10.0.1', '10.0.1'); //  0
compareVersions('10.1.1', '10.2.2'); // -1

Can also be used for sorting:

var versions = [
    '1.5.19'
    '1.2.3',
    '1.5.5',
];
console.log(versions.sort(compareVersions));

Outputs:

[
    '1.2.3',
    '1.5.5',
    '1.5.19'
]

Changelog

1.1.0 - 2015-03-18

• Added support for semver pre-release and metadata syntax.