Class SemanticVersion

constructor

• new SemanticVersion(
      _major: number,
      _minor: number,
      _patch: number,
      _prerelease?: string,
      _build?: string,
  ): SemanticVersion

  Constructs a new instance of a SemanticVersion with the supplied components.

  Parameters

  • _major: number

    the major version.
  • _minor: number

    the minor version.
  • _patch: number

    the patch version.
  • _prerelease: string = ''

    the optional prerelease specifier.
  • _build: string = ''

    the optional build specifier.

  Returns SemanticVersion

Static ReadonlyZERO

build

• get build(): string

  Returns string

major

• get major(): number

  Returns number

minor

• get minor(): number

  Returns number

patch

• get patch(): number

  Returns number

prerelease

• get prerelease(): string

  Returns string

compareTo

• compareTo(other: SemanticVersion): number

  Compares this version with another version.

  Parameters

  • other: SemanticVersion

    the other version to compare with

  Returns number

  a negative number if this version is less than the other, zero if they are equal, or a positive number if this version is greater

equals

• equals(object: unknown): boolean

  Checks if this version equals another object.

  Parameters

  • object: unknown

  Returns boolean

  true if the objects are equal, false otherwise

toString

• toString(): string

  Returns a string representation of this version.

  Returns string

  the version string

withClearedBuild

• withClearedBuild(): SemanticVersion

  Returns a new instance of a SemanticVersion with the build information cleared.

  Returns SemanticVersion

  a new instance of a SemanticVersion.

withClearedPrerelease

• withClearedPrerelease(): SemanticVersion

  Returns a new instance of a SemanticVersion with prerelease information cleared.

  Returns SemanticVersion

  a new instance of a SemanticVersion.

Staticparse

• parse(version: string): SemanticVersion

  Parses a semantic version string into the individual components.

  Parameters

  • version: string

    a semantic version number in string form.

  Returns SemanticVersion

  an instance of a SemanticVersion containing the individual components.

  Throws

  InvalidSemanticVersionException if the supplied string cannot be parsed as a semantic version number.

  Throws

  Error if the {@code version} argument is a {@code null} reference.