summaryrefslogtreecommitdiff
path: root/deps/node/deps/npm/node_modules/semver-diff/readme.md
blob: 06a172f16afa4fcf23c0e641f5515d70d79716b9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
# semver-diff [![Build Status](https://travis-ci.org/sindresorhus/semver-diff.svg?branch=master)](https://travis-ci.org/sindresorhus/semver-diff)

> Get the diff type of two [semver](https://github.com/isaacs/node-semver) versions: `0.0.1 0.0.2` → `patch`


## Install

```sh
$ npm install --save semver-diff
```


## Usage

```js
var semverDiff = require('semver-diff');

semverDiff('1.1.1', '1.1.2');
//=> 'patch'

semverDiff('0.0.1', '1.0.0');
//=> 'major'

semverDiff('0.0.1', '0.1.0');
//=> 'minor'

semverDiff('0.0.1-foo', '0.0.1-foo.bar');
//=> 'prerelease'

semverDiff('0.1.0', '0.1.0+foo');
//=> 'build'

semverDiff('0.0.1', '0.0.1');
//=> null

semverDiff('0.0.2', '0.0.1');
//=> null
```


## API

### semverDiff(versionA, versionB)

Returns the difference type between two semver versions, or `null` if they're identical or the second one is lower than the first.

Possible values: `'major'`, `'minor'`, `'patch'`, `'prerelease'`, `'build'`, `null`.


## License

MIT © [Sindre Sorhus](http://sindresorhus.com)