Class SemVer

Repersents a semantic version that is compliant with the specification found at https://semver.org/ (the same one Node uses).

Hierarchy

SemVer

Index

Constructors

Properties

major minor patch preReleaseBuild preReleaseTag

Methods

compare isEqual isGreater isLower isPrerelease fromString null

Constructors

constructor

new SemVer(major: number, minor: number, patch: number, preReleaseTag: SemVersionPrerelease, preReleaseBuild: number): SemVer
Parameters
- major: number
- minor: number
- patch: number
- preReleaseTag: SemVersionPrerelease
- preReleaseBuild: number
Returns SemVer
- Defined in index.ts:148

Properties

major

major: number

minor

minor: number

patch

patch: number

preReleaseBuild

preReleaseBuild: number

preReleaseTag

preReleaseTag: SemVersionPrerelease

Methods

`Private` compare

compare(candidate: SemVer): compare
Parameters
- candidate: SemVer
Returns compare
- Defined in index.ts:166

isEqual

isEqual(candidate: SemVer): boolean
Parameters
- candidate: SemVer
Returns boolean
- Defined in index.ts:223

isGreater

isGreater(candidate: SemVer): boolean
Parameters
- candidate: SemVer
Returns boolean
- Defined in index.ts:215

isLower

isLower(candidate: SemVer): boolean
Parameters
- candidate: SemVer
Returns boolean
- Defined in index.ts:219

isPrerelease

isPrerelease(): boolean
Returns boolean
- Defined in index.ts:162

`Static` fromString

fromString(version: string): null | SemVer
Returns a Semver if string is a valid semantic version string, Otherwise returns null.

Returns
Parameters
- version: string
  
  a semantic version string
Returns null | SemVer
- Defined in index.ts:138

`Static` null

null(): SemVer
returns a SemVer that has all patch members set to 0 (major, minor, patch) and no pre prelease tag.

Returns SemVer
- Defined in index.ts:127

Generated using TypeDoc