Class Version

constructor

• new Version(major, minor?, patch?): Version

• Parameters

  • major: number
  • Optionalminor: number
  • Optionalpatch: number

  Returns Version

Static ReadonlyEQUAL

Static ReadonlyGREATER_THAN

Static ReadonlyLESS_THAN

compare

• compare(b): number
• Sealed

  Parameters

  • b: Version

    The right side version

  Returns number

  Remarks

  This is the equivilant in using Version.compare(this, b). See copmare for more details.

getMajor

• getMajor(): number
• Sealed

  Returns number

  The major component of this version

getMinor

• getMinor(): number
• Sealed

  Returns number

  The minor component of this version

getPatch

• getPatch(): number
• Sealed

  Returns number

  The patch component of this version

toString

• toString(): string
• Sealed

  Returns string

  A semver-formatted string

Staticcompare

• compare(lhs, rhs): number

• Parameters

  • lhs: Version

    The left side version
  • rhs: Version

    The right side version

  Returns number

  Remarks

  Compares this version with another. If left side is greater than right side, GREATER_THAN is returned. If they are equal, EQUAL is returned. Otherwise, LESS_THAN is returned.

StaticparseVersionString

• parseVersionString(version): Version

• Parameters

  • version: string

    Semver formatted version string

  Returns Version

  A version object

  Remarks

  Parses a semver-formatted version string and creates a Version object. Does not support pre-release labels, which will be chopped off. If any dot notation segment is missing or is not parseable as an integer, it will default to 0.