Packages > pkl > pkl.semver

Version0.25.2

Overview
Properties
Methods

class Version

A semantic version.

Known subtypes:
Known usages:
All versions:

Properties

link

major: UInt

Major version zero (0.y.z) is for initial development. Anything MAY change at any time. The public API SHOULD NOT be considered stable.

Version 1.0.0 defines the public API. The way in which the version number is incremented after this release is dependent on this public API and how it changes.

Major version X (X.y.z | X > 0) MUST be incremented if any backwards incompatible changes are introduced to the public API. It MAY also include minor and patch level changes. Patch and minor version MUST be reset to 0 when major version is incremented.
link

minor: UInt

Minor version Y (x.Y.z | x > 0) MUST be incremented if new, backwards compatible functionality is introduced to the public API. It MUST be incremented if any public API functionality is marked as deprecated. It MAY be incremented if substantial new functionality or improvements are introduced within the private code. It MAY include patch level changes. Patch version MUST be reset to 0 when minor version is incremented.
link

patch: UInt

Patch version Z (x.y.Z | x > 0) MUST be incremented if only backwards compatible bug fixes are introduced. A bug fix is defined as an internal change that fixes incorrect behavior.
link
preRelease: String(matches(Regex(#"(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*"#)))?

A pre-release version MAY be denoted by appending a hyphen and a series of dot separated identifiers immediately following the patch version. Identifiers MUST comprise only ASCII alphanumerics and hyphens [0-9A-Za-z-]. Identifiers MUST NOT be empty. Numeric identifiers MUST NOT include leading zeroes. Pre-release versions have a lower precedence than the associated normal version. A pre-release version indicates that the version is unstable and might not satisfy the intended compatibility requirements as denoted by its associated normal version.
Examples:
- "1.0.0-alpha"
- "1.0.0-alpha.1"
- "1.0.0-0.3.7"
- "1.0.0-x.7.z.92"
- "1.0.0-x-y-z.–"
link

hidden

preReleaseIdentifiers: List<(Int|String)>
link
build: String(matches(Regex(#"[0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*"#)))?

Build metadata MAY be denoted by appending a plus sign and a series of dot separated identifiers immediately following the patch or pre-release version. Identifiers MUST comprise only ASCII alphanumerics and hyphens [0-9A-Za-z-]. Identifiers MUST NOT be empty. Build metadata MUST be ignored when determining version precedence. Thus two versions that differ only in the build metadata, have the same precedence.
Examples:
- `"1.0.0-alpha+001"
- "1.0.0+20130313144700"
- "1.0.0-beta+exp.sha.5114f85"
- "1.0.0+21AF26D3—-117B344092BD"
Note: Unlike ==, equals() and comparison methods such as isLessThan() ignore build.
link

hidden

buildIdentifiers: List<String>

Methods(show inherited)

link

function

Any.getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

toString(): unknown

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

Any.ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)Source

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

Typed.hasProperty(name: String): Boolean (pkl.base)Source

Tells if this object has a property with the given name.
link

function

Typed.getProperty(name: String): unknown (pkl.base)Source

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

Typed.getPropertyOrNull(name: String): unknown? (pkl.base)Source

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

Typed.toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

Typed.toMap(): Map<String, unknown> (pkl.base)Source

Converts this object to a Map.
link

function
equals(other: Version): Boolean

Tells whether this version is equal to other according to semantic versioning rules.
Facts:
```
semver.Version("1.0.0").equals(semver.Version("1.0.0"))
!(semver.Version("1.0.0").equals(semver.Version("1.0.1")))
semver.Version("1.0.0-alpha+001").equals(semver.Version("1.0.0-alpha+999"))
```
Note: version1.equals(version2) differs from version1 == version2 in that it ignores build.

link

function

isLessThan(other: Version): Boolean

Tells whether this version is less than other according to semantic versioning rules.

Facts:

semver.Version("1.0.0").isLessThan(semver.Version("2.0.0"))
semver.Version("2.0.0").isLessThan(semver.Version("2.1.0"))
semver.Version("2.1.0").isLessThan(semver.Version("2.1.1"))

semver.Version("1.0.0-alpha").isLessThan("1.0.0")

semver.Version("1.0.0-alpha").isLessThan(semver.Version("1.0.0-alpha.1"))
semver.Version("1.0.0-alpha.1").isLessThan(semver.Version("1.0.0-alpha.beta"))
semver.Version("1.0.0-alpha.beta").isLessThan(semver.Version("1.0.0-beta"))
semver.Version("1.0.0-beta").isLessThan(semver.Version("1.0.0-beta.2"))
semver.Version("1.0.0-beta.2").isLessThan(semver.Version("1.0.0-beta.11"))
semver.Version("1.0.0-beta.11").isLessThan(semver.Version("1.0.0-rc.1"))
semver.Version("1.0.0-rc.1").isLessThan(semver.Version("1.0.0"))

link

function

isLessThanOrEquals(other: Version): Boolean

Tells whether this version is less than or equal to other according to semantic versioning rules.
link

function

isGreaterThan(other: Version): Boolean

Tells whether this version is greater than other according to semantic versioning rules.
link

function

isGreaterThanOrEquals(other: Version): Boolean

Tells whether this version is greater than or equal to other according to semantic versioning rules.
link

function

isNormal(): Boolean

A normal version number MUST take the form X.Y.Z where X, Y, and Z are non-negative integers, and MUST NOT contain leading zeroes.
link

function

isStable(): Boolean

Tells if this version has a non-zero major and no preRelease.
link

function

toNormal(): Version

Strips preRelease and build from this version.