domain/updates/version

Interfaces

Version

Defined in: app/src/domain/updates/version.ts:2

A semantic version, such as 0.1.0 or 0.1.0-beta.2.

Properties

major

readonly major: number

Defined in: app/src/domain/updates/version.ts:3

minor

readonly minor: number

Defined in: app/src/domain/updates/version.ts:4

patch

readonly patch: number

Defined in: app/src/domain/updates/version.ts:5

prerelease

readonly prerelease: readonly (string | number)[]

Defined in: app/src/domain/updates/version.ts:7

Prerelease identifiers, such as ['beta', 2]; empty for a release.

Functions

compareVersions()

compareVersions(a, b): number

Defined in: app/src/domain/updates/version.ts:55

Compares two versions by semantic version precedence, so 0.1.0-beta.2 sorts before 0.1.0.

Parameters

a

string

First version.

b

string

Second version.

Returns

number

A negative number, zero or a positive number.

---

isVersion()

isVersion(text): boolean

Defined in: app/src/domain/updates/version.ts:37

Whether a text is a semantic version.

Parameters

text

string

Version text.

Returns

boolean

---

matchesVersionPrefix()

matchesVersionPrefix(version, prefix): boolean

Defined in: app/src/domain/updates/version.ts:85

Whether a version matches a version prefix, as set by the TargetVersionPrefix policy. A prefix covers whole components: 0.1 matches 0.1.4 but not 0.10.0.

Parameters

version

string

The version.

prefix

string

The prefix, such as 0.1 or 0.1..

Returns

boolean

---

parseVersion()

parseVersion(text): Version | undefined

Defined in: app/src/domain/updates/version.ts:18

Parses a semantic version. Build metadata is accepted and ignored.

Parameters

text

string

Version text.

Returns

Version | undefined

The version, or undefined when the text is not a semantic version.