Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SemverContext

Wrapper context for a given version delegate and comparator, in order to create more readable comparisons like

const version = new SemverContext(() => '1.2.3'); // or load dynamically from somewhere
console.log(version.greaterThan('1.0.0')); // true
console.log(version.greaterThanOrEqual('1.2.3')); // true
console.log(version.greaterThan('1.2.0')); // true
console.log(version.greaterThan(null)); // false
console.log(version.equals('not a version', true)); // true

Hierarchy

  • SemverContext

Index

Constructors

constructor

Properties

comparator

comparator: SemverComparator = ...

onGetVersion

onGetVersion: () => string

Type declaration

    • (): string
    • Returns string

Accessors

version

  • get version(): string

Methods

compare

  • compare(other: string, defaultValue?: number): number

eq

  • eq(other: string, defaultValue?: boolean): boolean
  • equals() alias

    Parameters

    • other: string
    • Optional defaultValue: boolean

    Returns boolean

equals

  • equals(other: string, defaultValue?: boolean): boolean

greaterThan

  • greaterThan(other: string, defaultValue?: boolean): boolean

greaterThanOrEqualTo

  • greaterThanOrEqualTo(other: string, defaultValue?: boolean): boolean

gt

  • gt(other: string, defaultValue?: boolean): boolean
  • greaterThan() alias

    Parameters

    • other: string
    • Optional defaultValue: boolean

    Returns boolean

gte

  • gte(other: string, defaultValue?: boolean): boolean
  • greaterThanOrEqualTo() alias

    Parameters

    • other: string
    • Optional defaultValue: boolean

    Returns boolean

lessThan

  • lessThan(other: string, defaultValue?: boolean): boolean

lessThanOrEqualTo

  • lessThanOrEqualTo(other: string, defaultValue?: boolean): boolean

lt

  • lt(other: string, defaultValue?: boolean): boolean
  • lessThan() alias

    Parameters

    • other: string
    • Optional defaultValue: boolean

    Returns boolean

lte

  • lte(other: string, defaultValue?: boolean): boolean
  • lessThanOrEqualTo() alias

    Parameters

    • other: string
    • Optional defaultValue: boolean

    Returns boolean

Generated using TypeDoc