Check version ranges like >=N and X || Y || Z with support for Node.js, Web Browsers, Deno, and TypeScript.
Range comparison of versions for the most common use cases. Fast with broad ecosystem support.
import satisfies from 'version-range'
console.log(satisfies('1.0', '>=1.0')) // true
console.log(satisfies('1.0', '1')) // true
console.log(satisfies('1.0', '1 || 2')) // true
console.log(satisfies('1.1.0', '^1.1')) // true
console.log(satisfies('1.1.0', '~1.1')) // true
console.log(satisfies('1.0.0', '5 || <=2')) // true
console.log(satisfies('1', '<=2')) // true
console.log(satisfies('1.0', '<=2')) // true
console.log(satisfies('1.0.0', '<=2')) // true
console.log(satisfies('2', '>1')) // true
console.log(satisfies('2', '>=1')) // true
console.log(satisfies('1', '>=1')) // true
console.log(satisfies('1.0', '>=1')) // true
console.log(satisfies('1.0.0', '>=1')) // true
console.log(satisfies('1', '>=1.0.0')) // true
console.log(satisfies('1.0', '>=1.0.0')) // true
console.log(satisfies('1.0.0', '>=1.0.0')) // true
console.log(satisfies('1', '^1')) // true
console.log(satisfies('1', '~1')) // false, not all 1.x versions (1.1, 1.2, etc) match 1.0.x
console.log(satisfies('1', '^1.1')) // false, not all 1.x versions (1.0) match >=1.1<2
console.log(satisfies('1', '~1.1')) // false, not all 1.x versions (1.0) match 1.1.x
console.log(satisfies('1.0.0', '^1')) // true
console.log(satisfies('1.0.0', '~1')) // trueThe above results are expected, but not what the semver package returns. The semver package has two different behaviours based on whether the version is coerced or not, alternating between expected and unexpected results. This package differs to match our actual expectations, as you can see above.
Doesn't do special handling for -releaseTag and 0.x versions.
This package comprises this suite of related packages:
And if you are specifically interested in Node.js and ECMAScript versions:
- Install:
npm install --save version-range - Import:
import pkg from ('version-range') - Require:
const pkg = require('version-range').default
import pkg from 'https://unpkg.com/version-range@^4.14.0/edition-deno/index.ts'<script type="module">
import pkg from '//cdn.skypack.dev/version-range@^4.14.0'
</script><script type="module">
import pkg from '//unpkg.com/version-range@^4.14.0'
</script><script type="module">
import pkg from '//dev.jspm.io/[email protected]'
</script>This package is published with the following editions:
version-range/source/index.tsis TypeScript source code with Import for modulesversion-range/edition-browsers/index.jsis TypeScript compiled against ES2022 for web browsers with Import for modulesversion-rangealiasesversion-range/edition-es5/index.jsversion-range/edition-es5/index.jsis TypeScript compiled against ES5 for Node.js 4 || 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modulesversion-range/edition-es2022-esm/index.jsis TypeScript compiled against ES2022 for Node.js 12 || 14 || 16 || 18 || 20 || 21 with Import for modulesversion-range/edition-types/index.d.tsis TypeScript compiled Types with Import for modulesversion-range/edition-deno/index.tsis TypeScript source code made to be compatible with Deno
Discover the release history by heading on over to the HISTORY.md file.
Discover how to contribute via the CONTRIBUTING.md file.
- Benjamin Lupton — Accelerating collaborative wisdom.
- Benjamin Lupton — Accelerating collaborative wisdom.
- Andrew Nesbitt — Software engineer and researcher
- Balsa — We're Balsa, and we're building tools for builders.
- Codecov — Empower developers with tools to improve code quality and testing.
- Frontend Masters — The training platform for web app engineering skills – from front-end to full-stack! 🚀
- Mr. Henry
- Poonacha Medappa
- Rob Morris
- Sentry — Real-time crash reporting for your web apps, mobile apps, and games.
- Syntax — Syntax Podcast
- Andrew Nesbitt
- Armen Mkrtchian
- Balsa
- Chad
- Codecov
- dr.dimitru
- Elliott Ditman
- entroniq
- Frontend Masters
- GitHub
- Hunter Beast
- Jean-Luc Geering
- Michael Duane Mooring
- Michael Harry Scepaniak
- Mohammed Shah
- Mr. Henry
- Nermal
- Pleo
- Poonacha Medappa
- Rob Morris
- Robert de Forest
- Sentry
- ServieJS
- Skunk Team
- Syntax
- WriterJohnBuck
Unless stated otherwise all works are:
- Copyright © Benjamin Lupton
and licensed under:
