Interface SemVer

A version number following semantic versioning. See https://semver.org/lang/de/

interface SemVer {
    build: string;
    compare(other): number;
    equals(other): boolean;
    hotfix: number;
    isPrerelease: boolean;
    lowestPreRelease(): SemVer;
    major: number;
    minor: number;
    patch: number;
    prerelease: readonly string[];
    stripBuild(): SemVer;
    stripPreRelease(): SemVer;
    toString(): string;
    version: string;
}

Properties

build hotfix isPrerelease major minor patch prerelease version

Methods

compare equals lowestPreRelease stripBuild stripPreRelease toString

Properties

Readonly build

build: string

The build number part of the version. e.g. 20240122001 from 1.2.3+20240122001

Readonly hotfix

hotfix: number

The hot fix part of the version e.g. 4 from 1.2.3.4

Deprecated

This should not be used anymore.

Readonly isPrerelease

isPrerelease: boolean

Indicates that the version is a pre-release version.

Readonly major

major: number

The major part of the version e.g. 1 from 1.2.3

Readonly minor

minor: number

The minor part of the version e.g. 2 from 1.2.3

Readonly patch

patch: number

The patch part of the version e.g. 3 from 1.2.3

Readonly prerelease

prerelease: readonly string[]

The parts of the pre-release string of the version e.g. [RC, 1] from 1.2.3-RC-1

Readonly version

version: string

The version as text.

Methods

compare

  • compare(other): number

  • Compares this version to another version.

    Parameters

    • other: SemVer

      The other version.

    Returns number

    x < 0: this version lower, x > 0:this version greater, x = 0: both versions are equal

equals

  • equals(other): boolean

  • Check, if this version equals another version.

    Parameters

    • other: SemVer

      The other version.

    Returns boolean

    true if the versions are equal.

lowestPreRelease

  • lowestPreRelease(): SemVer

  • Creates the lowest pre-release version of this version. The lowest pre-release version is a version with the pre-release -0 post fix. e.g. 1.2.3-0

    Returns SemVer

    The lowest pre-release version.

stripBuild

  • stripBuild(): SemVer

  • Creates a new version without the build part.

    Returns SemVer

    A new version without the build part or the same version, if it has no build part.

stripPreRelease

  • stripPreRelease(): SemVer

  • Creates new version without pre-release information.

    Returns SemVer

    A new version without the pre-release part or the same version if it has no pre-release part.

toString

  • toString(): string

  • String representation of the version.

    Returns string

    The version as String.

Settings

Member Visibility

Theme

On This Page

buildhotfixisPrereleasemajorminorpatchprereleaseversioncompareequalslowestPreReleasestripBuildstripPreReleasetoString

Generated using TypeDoc