.gitignore added
[dotfiles/.git] / .config / coc / extensions / node_modules / coc-prettier / node_modules / semver-diff / readme.md
1 # semver-diff [![Build Status](https://travis-ci.org/sindresorhus/semver-diff.svg?branch=master)](https://travis-ci.org/sindresorhus/semver-diff)
2
3 > Get the diff type of two [semver](https://github.com/isaacs/node-semver) versions: `0.0.1 0.0.2` → `patch`
4
5
6 ## Install
7
8 ```sh
9 $ npm install --save semver-diff
10 ```
11
12
13 ## Usage
14
15 ```js
16 var semverDiff = require('semver-diff');
17
18 semverDiff('1.1.1', '1.1.2');
19 //=> 'patch'
20
21 semverDiff('0.0.1', '1.0.0');
22 //=> 'major'
23
24 semverDiff('0.0.1', '0.1.0');
25 //=> 'minor'
26
27 semverDiff('0.0.1-foo', '0.0.1-foo.bar');
28 //=> 'prerelease'
29
30 semverDiff('0.1.0', '0.1.0+foo');
31 //=> 'build'
32
33 semverDiff('0.0.1', '0.0.1');
34 //=> null
35
36 semverDiff('0.0.2', '0.0.1');
37 //=> null
38 ```
39
40
41 ## API
42
43 ### semverDiff(versionA, versionB)
44
45 Returns the difference type between two semver versions, or `null` if they're identical or the second one is lower than the first.
46
47 Possible values: `'major'`, `'minor'`, `'patch'`, `'prerelease'`, `'build'`, `null`.
48
49
50 ## License
51
52 MIT © [Sindre Sorhus](http://sindresorhus.com)