Skip to content

docs: clarify includePrerelease hyphen ranges #888

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vibhor-aggr wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: clarify includePrerelease hyphen ranges #888

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -304,6 +304,11 @@ provided tuple parts.
* `1.2.3 - 2.3` := `>=1.2.3 <2.4.0-0`
* `1.2.3 - 2` := `>=1.2.3 <3.0.0-0`

When `includePrerelease` is set, partial versions in hyphen ranges
include prereleases at the expanded lower bound. For example,
`1 - 2` is treated as `>=1.0.0-0 <3.0.0-0`, so `1.0.0-pre`
satisfies the range with `includePrerelease`.

#### X-Ranges `1.2.x` `1.X` `1.2.*` `*`

Any of `X`, `x`, or `*` may be used to "stand in" for one of the
Expand Down Expand Up @@ -677,4 +682,3 @@ The following modules are available:
* `require('semver/ranges/subset')`
* `require('semver/ranges/to-comparators')`
* `require('semver/ranges/valid')`