diff options
| author | ruki <waruqi@gmail.com> | 2018-11-08 00:38:48 +0800 |
|---|---|---|
| committer | ruki <waruqi@gmail.com> | 2018-11-07 21:53:09 +0800 |
| commit | 26105034da4fcce7ac883c899d781f016559310d (patch) | |
| tree | c459a5dc4e3aa0972d9919033ece511ce76dd129 /node_modules/semver-diff/readme.md | |
| parent | 2c77f00f1a7ecb6c8192f9c16d3b2001b254a107 (diff) | |
| download | xmake-docs-26105034da4fcce7ac883c899d781f016559310d.tar.gz xmake-docs-26105034da4fcce7ac883c899d781f016559310d.zip | |
switch to vuepress
Diffstat (limited to 'node_modules/semver-diff/readme.md')
| -rw-r--r-- | node_modules/semver-diff/readme.md | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/node_modules/semver-diff/readme.md b/node_modules/semver-diff/readme.md new file mode 100644 index 00000000..06a172f1 --- /dev/null +++ b/node_modules/semver-diff/readme.md @@ -0,0 +1,52 @@ +# semver-diff [](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) |
