version-range

Check version ranges like >=N and X || Y || Z with support for Node.js, Web Browsers, Deno, and TypeScript.

Usage

Complete API Documentation.

Range comparison of versions for the most common use cases. Fast with broad ecosystem support.

1import satisfies from 'version-range'
2console.log(satisfies('1.0', '>=1.0')) // true
3console.log(satisfies('1.0', '1')) // true
4console.log(satisfies('1.0', '1 || 2')) // true
5console.log(satisfies('1.1.0', '^1.1')) // true
6console.log(satisfies('1.1.0', '~1.1')) // true
7console.log(satisfies('1.0.0', '5 || <=2')) // true
8
9console.log(satisfies('1', '<=2')) // true
10console.log(satisfies('1.0', '<=2')) // true
11console.log(satisfies('1.0.0', '<=2')) // true
12
13console.log(satisfies('2', '>1')) // true
14console.log(satisfies('2', '>=1')) // true
15console.log(satisfies('1', '>=1')) // true
16console.log(satisfies('1.0', '>=1')) // true
17console.log(satisfies('1.0.0', '>=1')) // true
18console.log(satisfies('1', '>=1.0.0')) // true
19console.log(satisfies('1.0', '>=1.0.0')) // true
20console.log(satisfies('1.0.0', '>=1.0.0')) // true
21
22console.log(satisfies('1', '^1')) // true
23console.log(satisfies('1', '~1')) // false, not all 1.x versions (1.1, 1.2, etc) match 1.0.x
24console.log(satisfies('1', '^1.1')) // false, not all 1.x versions (1.0) match >=1.1<2
25console.log(satisfies('1', '~1.1')) // false, not all 1.x versions (1.0) match 1.1.x
26console.log(satisfies('1.0.0', '^1')) // true
27console.log(satisfies('1.0.0', '~1')) // true

The 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.

Related

This package comprises this suite of related packages:

• version-clean
• version-compare
• version-range

And if you are specifically interested in Node.js and ECMAScript versions:

• ecmascript-versions
• nodejs-ecmascript-compatibility
• nodejs-releases
• nodejs-schedule
• nodejs-versions

Install

npm

• Install: npm install --save version-range
• Import: import pkg from ('version-range')
• Require: const pkg = require('version-range').default

Deno

1import pkg from 'https://unpkg.com/version-range@^4.14.0/edition-deno/index.ts'

Skypack

1<script type="module">
2    import pkg from '//cdn.skypack.dev/version-range@^4.14.0'
3</script>

unpkg

1<script type="module">
2    import pkg from '//unpkg.com/version-range@^4.14.0'
3</script>

jspm

1<script type="module">
2    import pkg from '//dev.jspm.io/version-range@4.14.0'
3</script>

Editions

This package is published with the following editions:

• version-range/source/index.ts is TypeScript source code with Import for modules
• version-range/edition-browsers/index.js is TypeScript compiled against ES2022 for web browsers with Import for modules
• version-range aliases version-range/edition-es5/index.js
• version-range/edition-es5/index.js is TypeScript compiled against ES5 for Node.js 4 || 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modules
• version-range/edition-es2022-esm/index.js is TypeScript compiled against ES2022 for Node.js 12 || 14 || 16 || 18 || 20 || 21 with Import for modules
• version-range/edition-types/index.d.ts is TypeScript compiled Types with Import for modules
• version-range/edition-deno/index.ts is TypeScript source code made to be compatible with Deno

History

Discover the release history by heading on over to the HISTORY.md file.

Backers

Code

Discover how to contribute via the CONTRIBUTING.md file.

Authors

• Benjamin Lupton — Accelerating collaborative wisdom.

Maintainers

• Benjamin Lupton — Accelerating collaborative wisdom.

Contributors

• Benjamin Lupton — view contributions

Finances

Sponsors

• 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

Donors

• 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

License

Unless stated otherwise all works are:

• Copyright © Benjamin Lupton

and licensed under:

• Artistic License 2.0