Class VersionNumber

constructor

• new VersionNumber(
      input: string | VersionNumber | [number, number, number],
  ): VersionNumber

  Parameters

  • input: string | VersionNumber | [number, number, number]

    The input to create a new instance of VersionNumber from.

  Returns VersionNumber

Readonlymajor

Readonlyminor

Readonlypatch

type

• get type(): VersionType

  Gets the current version type of the current instance of VersionNumber.

  Returns VersionType

  Either "major", "minor", or "patch", depending on the version type.

[toPrimitive]

• "[toPrimitive]"(hint: "string" | "number" | "default"): string

  Ensures that the VersionNumber behaves correctly when attempted to be coerced to a string.

  Parameters

  • hint: "string" | "number" | "default"

    Not used as of now, but generally used to help with numeric coercion, I think (which we most likely do not need for version numbers).

  Returns string

  A stringified representation of the current version number, prefixed with v.

increment

• increment(incrementType: VersionType): VersionNumber

  Increments the current version number by the given increment type, returning the result as a new reference in memory.

  Parameters

  • incrementType: VersionType

    The type of increment. Can be one of the following:

    • "major": Change the major version v1.2.3 → v2.0.0
    • "minor": Change the minor version v1.2.3 → v1.3.0
    • "patch": Change the patch version v1.2.3 → v1.2.4

  Returns VersionNumber

  A new instance of VersionNumber with the increment applied.

toJSON

• toJSON(): string

  Ensures that the VersionNumber behaves correctly when attempted to be converted to JSON.

  Returns string

  A stringified representation of the current version number, prefixed with v.

toString

• toString(options?: VersionNumberToStringOptions): string

  Get a string representation of the current version number.

  Parameters

  • Optionaloptions: VersionNumberToStringOptions

    Extra additional options to apply.

  Returns string

  A stringified representation of the current version number, leaving out the prefix if omitPrefix option was set to true.

StaticisEqual

• isEqual(firstVersion: VersionNumber, secondVersion: VersionNumber): boolean

  Checks if the provided version numbers have the exact same major, minor, and patch numbers.

  Parameters

  • firstVersion: VersionNumber

    The first version number to compare.

  • secondVersion: VersionNumber

    The second version number to compare.

  Returns boolean

  true if the provided version numbers have exactly the same major, minor, and patch numbers, and returns false otherwise.