diff options
author | 2020-11-16 00:10:28 +0100 | |
---|---|---|
committer | 2020-11-16 00:10:28 +0100 | |
commit | e06ec920f7a5d784e674c4c4b4e6d1da3dc7391d (patch) | |
tree | 55713f725f77b44ebfec86e4eec3ce33e71458ca /node_modules/semver-diff/readme.md | |
download | website_creator-e06ec920f7a5d784e674c4c4b4e6d1da3dc7391d.tar.gz website_creator-e06ec920f7a5d784e674c4c4b4e6d1da3dc7391d.tar.bz2 website_creator-e06ec920f7a5d784e674c4c4b4e6d1da3dc7391d.zip |
api, login, auth
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 0000000..06a172f --- /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) |