semver-parser

SemVer Parser

Parse, determine, compare SemVer.

Install

npm install semver-parser

API

NOTE: Is "v1.2.3" a semantic version?

Is "v1.2.3" a semantic version?

No, "v1.2.3" is not a semantic version. However, prefixing a semantic version with a "v" is a common way (in English) to indicate it is a version number.

For ease of use, this parser supports "v" prefixed string. If you do not want to accept "v" prefix, set strict param to true.

parseSemVer(version, strict)

Parses version string.

• @param {string} version - version string
• @param {boolean} [strict] - reject "v" prefixed
• @returns {Object} - parsed result, contains properties below
  • version {string} - given version string
  • matches {boolean} - matches SemVer format
  • major {number|undefined} - major version
  • minor {number|undefined} - minor version
  • patch {number|undefined} - patch version
  • pre {Array<string|number>|undefined} - pre release version in array
  • build {Array<string|number>|undefined} - build ID in array

isValidSemVer(version, strict)

Determine whether the given argument is a valid SemVer string.

• @param {string} version - version string
• @param {boolean} [strict] - reject "v" prefixed
• @returns {boolean} - result

compareSemVer(version, base, strict)

Compare versions in SemVer format.

• @param {string} version - version string
• @param {string} base - base version string to compare from
• @param {boolean} [strict] - reject "v" prefixed
• @returns {number}
  • -1 or negative number, if version is less than base version
  • 0, if version is equal to base version
  • 1 or positive number, if version is greater than base version