Class OnmsVersion

constructor

• new OnmsVersion(version?: string, displayVersion?: string): API.OnmsVersion

  Construct a new version.

  Parameters

  • Optionalversion: string

    The numeric version.
  • OptionaldisplayVersion: string

    The full display version (including extra designators like x.x.x-SNAPSHOT).

  Returns API.OnmsVersion

Readonlyversion

displayVersion

• get displayVersion(): string

  The display version (ex: 19.0.0-SNAPSHOT).

  Returns string

clone

• clone(): API.OnmsVersion

  Create a new version object from this existing one.

  Returns API.OnmsVersion

eq

• eq(compare?: string): boolean

  Returns true if this version is equal to the passed version.

  Parameters

  • compare: string = '0.0.0'

  Returns boolean

equals

• equals(that: API.OnmsVersion): boolean

  Whether this version object is the same as another.

  Parameters

  • that: API.OnmsVersion

  Returns boolean

ge

• ge(compare?: string): boolean

  Returns true if this version is greater than or equal to the passed version.

  Parameters

  • compare: string = '0.0.0'

  Returns boolean

gt

• gt(compare?: string): boolean

  Returns true if this version is greater than the passed version.

  Parameters

  • compare: string = '0.0.0'

  Returns boolean

le

• le(compare?: string): boolean

  Returns true if this version is less than or equal to the passed version.

  Parameters

  • compare: string = '0.0.0'

  Returns boolean

lt

• lt(compare?: string): boolean

  Returns true if this version is less than the passed version.

  Parameters

  • compare: string = '0.0.0'

  Returns boolean

toString

• toString(): string

  A human-readable representation of this version.

  Returns string