Class SemverComparator

Core implementation for comparison functionality with error catching baked in.

Hierarchy

SemverComparator

Index

Constructors

constructor

Properties

Accessors

sortable

Methods

Constructors

constructor

new SemverComparator(onCompareVersions: SemverComparisonDelegate): SemverComparator

- Defined in core/semver-comparator.ts:17
Parameters
- onCompareVersions: SemverComparisonDelegate
Returns SemverComparator

Properties

compareFailureResult

compareFailureResult: number = ...

Customizable value to be used when the comparison delegate explodes.

onCompareVersions

onCompareVersions: SemverComparisonDelegate

Accessors

sortable

get sortable(): (a: string, b: string) => number

- Defined in core/semver-comparator.ts:25
Wrap this comparator as a delegate to be passed to arrays or other sortable constructs.

Returns (a: string, b: string) => number
- - (a: string, b: string): number
  - Wrap this comparator as a delegate to be passed to arrays or other sortable constructs.
    
    Parameters
    - a: string
    - b: string
    Returns number

Methods

compare

compare(v1: string, v2: string, defaultValue?: number): number

- Defined in core/semver-comparator.ts:107
Returns the comparison result between the two given versions, where:
- -1 indicates v1 < v2
- 0 indicates v1 <= v2 | v1 = v2 | v1 >= v2
- 1 indicates v1 > v2
Returns defaultValue on comparison failure.
Parameters
- v1: string
- v2: string
- defaultValue: number = ...
Returns number

eq

eq(v1: string, v2: string, defaultValue?: boolean): boolean

- Defined in core/semver-comparator.ts:81
equals() alias

Parameters
- v1: string
- v2: string
- Optional defaultValue: boolean
Returns boolean

equals

equals(v1: string, v2: string, defaultValue?: boolean): boolean

- Defined in core/semver-comparator.ts:46
Returns true if v1 == v2 - defaults to defaultValue on error.

Parameters
- v1: string
- v2: string
- defaultValue: boolean = false
Returns boolean

greaterThan

greaterThan(v1: string, v2: string, defaultValue?: boolean): boolean

- Defined in core/semver-comparator.ts:60
Returns true if v1 > v2 - defaults to defaultValue on error.

Parameters
- v1: string
- v2: string
- defaultValue: boolean = false
Returns boolean

greaterThanOrEqualTo

greaterThanOrEqualTo(v1: string, v2: string, defaultValue?: boolean): boolean

- Defined in core/semver-comparator.ts:53
Returns true if v1 >= v2 - defaults to defaultValue on error.

Parameters
- v1: string
- v2: string
- defaultValue: boolean = false
Returns boolean

gt

gt(v1: string, v2: string, defaultValue?: boolean): boolean

- Defined in core/semver-comparator.ts:95
greaterThan() alias

Parameters
- v1: string
- v2: string
- Optional defaultValue: boolean
Returns boolean

gte

gte(v1: string, v2: string, defaultValue?: boolean): boolean

- Defined in core/semver-comparator.ts:88
greaterThanOrEqualTo() alias

Parameters
- v1: string
- v2: string
- Optional defaultValue: boolean
Returns boolean

lessThan

lessThan(v1: string, v2: string, defaultValue?: boolean): boolean

- Defined in core/semver-comparator.ts:32
Returns true if v1 < v2 - defaults to defaultValue on error.

Parameters
- v1: string
- v2: string
- defaultValue: boolean = false
Returns boolean

lessThanOrEqualTo

lessThanOrEqualTo(v1: string, v2: string, defaultValue?: boolean): boolean

- Defined in core/semver-comparator.ts:39
Returns true if v1 <= v2 - defaults to defaultValue on error.

Parameters
- v1: string
- v2: string
- defaultValue: boolean = false
Returns boolean

lt

lt(v1: string, v2: string, defaultValue?: boolean): boolean

- Defined in core/semver-comparator.ts:67
lessThan() alias

Parameters
- v1: string
- v2: string
- Optional defaultValue: boolean
Returns boolean

lte

lte(v1: string, v2: string, defaultValue?: boolean): boolean

- Defined in core/semver-comparator.ts:74
lessThanOrEqualTo() alias

Parameters
- v1: string
- v2: string
- Optional defaultValue: boolean
Returns boolean

test

test(v1: string, v2: string, type: SemverComparisonType, defaultValue: boolean): boolean

- Defined in core/semver-comparator.ts:115
Returns true if the comparison between v1 and v2 results in the given type. Returns defaultValue on comparison error.

Parameters
- v1: string
- v2: string
- type: SemverComparisonType
- defaultValue: boolean
Returns boolean

Generated using TypeDoc