Function default

  • default(): SemVer

  • Creates a new Version 0.0.0.

    Returns SemVer

  • default(major?, minor?, patch?, hotfix?, prerelease?, build?): SemVer

  • Creates a new version.

    Parameters

    • Optional major: number

      major version part (1 in 1.2.3)

    • Optional minor: number

      minor version part (2 in 1.2.3)

    • Optional patch: number

      patch version part (3 in 1.2.3)

    • Optional hotfix: number

      hotfix version part (4 in 1.2.3.4)

    • Optional prerelease: readonly string[]

      pre-release part (SNAPSHOT in 1.2.3-SNAPSHOT)

    • Optional build: string

      build part (20240123 in 1.2.3+20240123)

    Returns SemVer

  • default(versionString?, ignoreBuild?): SemVer

  • Parses a version string to a version.

    Parameters

    • Optional versionString: string

      version string, e.g. 1.2.3

    • Optional ignoreBuild: boolean

      ignore build part in version, for example would create a version without 20240123 from string 1.2.3+20240123

    Returns SemVer

Properties

compare equals

Properties

compare

compare: ((a, b) => number)

Compares two versions.

Type declaration

Returns

< 0 = a < b
> 0 = a > b
  0 = a == b

equals

equals: ((a, b) => boolean)

Checks if two versions are equal.

Type declaration

Settings

Member Visibility

Theme

On This Page

compareequals

Generated using TypeDoc