🏷️ Checks whether a string is a valid Semantic Versioning 2.0.0 version.

Syntax

TypeScript
import { semverIsValid } from '@opentf/std';

semverIsValid(version: string): boolean;

Parameters

NameTypeDescription
versionstringThe string to check.

Returns

true if the string is a valid SemVer version. Never throws, including on non-string input.

A leading v and surrounding whitespace are tolerated. Partial versions such as 1.2 and ranges such as ^1.2.3 are not versions, so they are rejected.

Examples

TypeScript
semverIsValid('1.2.3')        //=> true
semverIsValid('v1.2.3-beta.1') //=> true
semverIsValid('1.2.3+build')   //=> true

semverIsValid('1.2')    //=> false
semverIsValid('^1.2.3') //=> false
semverIsValid('01.2.3') //=> false — leading zeroes are invalid
Last updated on
Edit this page