Function cmp

Pass in a comparison string, and it'll call the corresponding semver comparison function.

Throws if an invalid comparison string is provided.

Example

cmp('1.2.3', '>', '1.2.2') // true

Remarks

build identifier ([+BUILD]) is not taken into account in all operations but "===" and "!==" which do simple comparison of the whole strings

  • cmp(
        v1: string,
        operator: Operator,
        v2: string,
        optionsOrLoose?: boolean | Options,
    ): boolean

    Parameters

    • v1: string

      first version string

    • operator: Operator

      operator string (could be "===", "!==", "", "=", "==", "!=", ">", ">=", "<", "<=")

    • v2: string

      second version string

    • OptionaloptionsOrLoose: boolean | Options

      an options object { loose } (where loose is the only available option) or a boolean indicating whether to enable loose mode. In loose mode, the parser is more forgiving with imperfectly formatted semver strings

    Returns boolean

    true if the comparison is true, false otherwise

Settings

Member Visibility