Skip to content

Commit

Permalink
deps: updating semver docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Audrey Eschright committed Jan 9, 2019
1 parent 887e943 commit 41f1552
Showing 1 changed file with 16 additions and 5 deletions.
21 changes: 16 additions & 5 deletions doc/misc/semver.md
Expand Up @@ -29,8 +29,6 @@ As a command-line utility:
```
$ semver -h

SemVer 5.3.0

A JavaScript implementation of the http://semver.org/ specification
Copyright Isaac Z. Schlueter

Expand All @@ -54,6 +52,9 @@ Options:
-l --loose
Interpret versions and ranges loosely

-p --include-prerelease
Always include prerelease versions in range matching

-c --coerce
Coerce a string into SemVer if possible
(does not imply --loose)
Expand Down Expand Up @@ -289,9 +290,19 @@ part ::= nr | [-0-9A-Za-z]+

## Functions

All methods and classes take a final `loose` boolean argument that, if
true, will be more forgiving about not-quite-valid semver strings.
The resulting output will always be 100% strict, of course.
All methods and classes take a final `options` object argument. All
options in this object are `false` by default. The options supported
are:

- `loose` Be more forgiving about not-quite-valid semver strings.
(Any resulting output will always be 100% strict compliant, of
course.) For backwards compatibility reasons, if the `options`
argument is a boolean value instead of an object, it is interpreted
to be the `loose` param.
- `includePrerelease` Set to suppress the [default
behavior](https://github.com/npm/node-semver#prerelease-tags) of
excluding prerelease tagged versions from ranges unless they are
explicitly opted into.

Strict-mode Comparators and Ranges will be strict about the SemVer
strings that they parse.
Expand Down

0 comments on commit 41f1552

Please sign in to comment.