diff options
Diffstat (limited to 'node_modules/semver-diff/readme.md')
| -rw-r--r-- | node_modules/semver-diff/readme.md | 77 |
1 files changed, 0 insertions, 77 deletions
diff --git a/node_modules/semver-diff/readme.md b/node_modules/semver-diff/readme.md deleted file mode 100644 index 6e21aff..0000000 --- a/node_modules/semver-diff/readme.md +++ /dev/null @@ -1,77 +0,0 @@ -# semver-diff [](https://travis-ci.org/sindresorhus/semver-diff) - -> Get the diff type of two [semver](https://github.com/npm/node-semver) versions: `0.0.1 0.0.2` → `patch` - - -## Install - -``` -$ npm install semver-diff -``` - - -## Usage - -```js -const semverDiff = require('semver-diff'); - -semverDiff('1.1.1', '1.1.2'); -//=> 'patch' - -semverDiff('1.1.1-foo', '1.1.2'); -//=> 'prepatch' - -semverDiff('0.0.1', '1.0.0'); -//=> 'major' - -semverDiff('0.0.1-foo', '1.0.0'); -//=> 'premajor' - -semverDiff('0.0.1', '0.1.0'); -//=> 'minor' - -semverDiff('0.0.1-foo', '0.1.0'); -//=> 'preminor' - -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'); -//=> undefined - -semverDiff('0.0.2', '0.0.1'); -//=> undefined -``` - - -## API - -### semverDiff(versionA, versionB) - -Returns the difference type between two semver versions, or `undefined` if they're identical or the second one is lower than the first. - -Possible values: `'major'`, `'premajor'`, `'minor'`, `'preminor'`, `'patch'`, `'prepatch'`, `'prerelease'`, `'build'`, `undefined`. - - -## Related - -- [latest-semver](https://github.com/sindresorhus/latest-semver) - Get the latest stable semver version from an array of versions -- [to-semver](https://github.com/sindresorhus/to-semver) - Get an array of valid, sorted, and cleaned semver versions from an array of strings -- [semver-regex](https://github.com/sindresorhus/semver-regex) - Regular expression for matching semver versions -- [semver-truncate](https://github.com/sindresorhus/semver-truncate) - Truncate a semver version: `1.2.3` → `1.2.0` - - ---- - -<div align="center"> - <b> - <a href="https://tidelift.com/subscription/pkg/npm-semver-diff?utm_source=npm-semver-diff&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a> - </b> - <br> - <sub> - Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies. - </sub> -</div> |