Skip to content

parse

Parses a semantic version string into its components according to SemVer 2.0.0 specification

Supports:

  • Core version: MAJOR.MINOR.PATCH
  • Pre-release: -alpha, -beta.1, -rc.1, -0.3.7, -x.7.z.92
  • Build metadata: +build, +sha.abc123, +20130313144700
  • Optional ‘v’ prefix (commonly used in git tags)

Available since v2.0.0

import { parse } from '@helpers4/version';
parse(version: string): ParsedVersion
ParameterTypeDescription
versionstringVersion string to parse

ParsedVersion — Parsed version object with major, minor, patch, prerelease, and build

Breaks a semantic version string into its components.

parse('1.2.3')
// => { major: 1, minor: 2, patch: 3, prerelease: [], build: [] }

Handles prerelease identifiers and optional v prefix.

parse('v2.0.0-alpha.1')
// => { major: 2, minor: 0, patch: 0, prerelease: ['alpha', '1'], build: [] }

Represents a parsed semantic version according to SemVer 2.0.0 specification

interface ParsedVersion {
  build: string[];
  major: number;
  minor: number;
  patch: number;
  prerelease: string[];
}

View source on GitHub