version-range
TypeScript icon, indicating that this package has built-in type declarations

4.14.0 • Public • Published

version-range

Status of the GitHub Workflow: bevry NPM version NPM downloads
GitHub Sponsors donate button ThanksDev donate button Patreon donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button
Discord server badge Twitch community badge

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.

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')) // 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:

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

Install

npm

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

Deno

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

Skypack

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

unpkg

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

jspm

<script type="module">
    import pkg from '//dev.jspm.io/version-range@4.14.0'
</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

Maintainers

Contributors

Finances

GitHub Sponsors donate button ThanksDev donate button Patreon donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button

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

License

Unless stated otherwise all works are:

and licensed under:

Package Sidebar

Install

npm i version-range

Weekly Downloads

15,939

Version

4.14.0

License

Artistic-2.0

Unpacked Size

83.1 kB

Total Files

16

Last publish

Collaborators

  • bevryme