Skip to content

Commit a462bec

Browse files
committed
Document includePrerelease flag more
Include it in the section on Prerelease Tags in the range description section.
1 parent c529221 commit a462bec

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

+7
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,13 @@ the user is indicating that they are aware of the risk. However, it
137137
is still not appropriate to assume that they have opted into taking a
138138
similar risk on the *next* set of prerelease versions.
139139
140+
Note that this behavior can be suppressed (treating all prerelease
141+
versions as if they were normal versions, for the purpose of range
142+
matching) by setting the `includePrerelease` flag on the options
143+
object to any
144+
[functions](https://github.com/npm/node-semver#functions) that do
145+
range matching.
146+
140147
#### Prerelease Identifiers
141148
142149
The method `.inc` takes an additional `identifier` string argument that

0 commit comments

Comments
 (0)