Class Version

Version describes a Major.Minor.Patch version for use in semantic versioning.

export
class: Version

Hierarchy

Version

Index

Constructors

constructor

Properties

digits

Methods

Constructors

constructor

new Version(digits: number[]): Version

- Defined in version.ts:26
Creates a Version from a three-digit array.

memberof

Version

Parameters
- digits: number[]
Returns Version

Properties

digits

digits: number[]

Methods

compare

compare(rhs: Version): number

- Defined in version.ts:46
Compares two versions. Returns -1 if the right version is newer than the left version. Returns 0 if the right version is equal to the left version. Returns 1 if the right version is older than the left version.

memberof

Version

Parameters
- rhs: Version
Returns number

equalTo

equalTo(rhs: Version): boolean

- Defined in version.ts:89
Returns whether this version is equal to another version.

memberof

Version

Parameters
- rhs: Version
Returns boolean

greaterThan

greaterThan(rhs: Version): boolean

- Defined in version.ts:78
Returns whether this version is greater than (i.e. newer than) another version.

memberof

Version

Parameters
- rhs: Version
Returns boolean

lessThan

lessThan(rhs: Version): boolean

- Defined in version.ts:67
Returns whether this version is less than (i.e. older than) another version.

memberof

Version

Parameters
- rhs: Version
Returns boolean

lessThanOrEqual

lessThanOrEqual(rhs: Version): boolean

- Defined in version.ts:100
Returns whether this version is less than (i.e. older than) or equal to another version.

memberof

Version

Parameters
- rhs: Version
Returns boolean

toString

toString(): string

- Defined in version.ts:110
Returns a string representing the version.

memberof

Version

Returns string

Static fromString

fromString(version: string): Version

- Defined in version.ts:24
Parses a string and returns a Version.

static

memberof

Version

Parameters
- version: string
Returns Version

Generated using TypeDoc