Function increment
- increment(version, release, options?): SemVer
Parameters
- version: SemVer
The version to increment
- release: ReleaseType
The type of increment to perform
- options: IncrementOptions = {}
Additional options
Returns SemVer
The new version
Example: Usage
import { increment, parse } from "@std/semver";
import { assertEquals } from "@std/assert";
const version = parse("1.2.3");
assertEquals(increment(version, "major"), parse("2.0.0"));
assertEquals(increment(version, "minor"), parse("1.3.0"));
assertEquals(increment(version, "patch"), parse("1.2.4"));
assertEquals(increment(version, "prerelease"), parse("1.2.4-0"));
const prerelease = parse("1.2.3-beta.0");
assertEquals(increment(prerelease, "prerelease"), parse("1.2.3-beta.1"));- version: SemVer
Returns the new SemVer resulting from an increment by release type.
premajor,preminorandprepatchwill bump the version up to the next version, based on the type, and will also add prerelease metadata.If called from a non-prerelease version, the
prereleasewill work the same asprepatch. The patch version is incremented and then is made into a prerelease. If the input version is already a prerelease it will simply increment the prerelease metadata.If a prerelease identifier is specified without a number then a number will be added. For example
prewill result inpre.0. If the existing version already has a prerelease with a number and its the same prerelease identifier then the number will be incremented. If the identifier differs from the new identifier then the new identifier is applied and the number is reset to0.If the input version has build metadata it will be preserved on the resulting version unless a new build parameter is specified. Specifying
""will unset existing build metadata.