Skip to content

Commit 5b7a0a2

Browse files
committed
Doc for inc() function
1 parent e7bf948 commit 5b7a0a2

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -424,17 +424,18 @@ Strict-mode Comparators and Ranges will be strict about the SemVer
424424
strings that they parse.
425425

426426
* `valid(v)`: Return the parsed version, or null if it's not valid.
427-
* `inc(v, release, options, identifier, identifierBase)`:
427+
* `inc(v, releaseType, options, identifier, identifierBase)`:
428428
Return the version incremented by the release
429429
type (`major`, `premajor`, `minor`, `preminor`, `patch`,
430-
`prepatch`, or `prerelease`), or null if it's not valid
430+
`prepatch`, `prerelease`, or `release`), or null if it's not valid
431431
* `premajor` in one call will bump the version up to the next major
432432
version and down to a prerelease of that major version.
433433
`preminor`, and `prepatch` work the same way.
434434
* If called from a non-prerelease version, `prerelease` will work the
435435
same as `prepatch`. It increments the patch version and then makes a
436436
prerelease. If the input version is already a prerelease it simply
437437
increments it.
438+
* `release` will remove any prerelease part of the version.
438439
* `identifier` can be used to prefix `premajor`, `preminor`,
439440
`prepatch`, or `prerelease` version increments. `identifierBase`
440441
is the base to be used for the `prerelease` identifier.

0 commit comments

Comments
 (0)