requireValidVersion

function requireValidVersion(
  value: string | null | undefined,
  message: string = "Expected a valid version."
): string;

Dot-separated groups of digits, any number of them. A pre-release suffix, a leading v and an empty group are all rejected, so "1.2.3-beta" does not pass even though SemVer allows it.

isX and nonX answer a question and never interrupt control flow; requireX and requireNonX hand the value back or throw. The scheme is explained in Validation conventions.

Parameters

Parameter	Type	Description
`value`	`string \\| null \\| undefined`	The value to validate.
`message` (optional) `= "Expected a valid version."`	`string`	The message of the exception. A default is used when omitted.

Returns

string — the same value, typed as a version string.

Throws

Exception	Condition
`IllegalArgumentException`	the value is not a version string.

Examples

What passes and what does not

requireValidVersion("1"); // => "1"
requireValidVersion("1.2.3"); // => "1.2.3"
requireValidVersion("1.2.3-beta"); // throws IllegalArgumentException
requireValidVersion("v1.2"); // throws IllegalArgumentException

Source

src/lang/string/requireValidVersion.ts

23 September 2026

This documentation was generated with AI (Claude) from the library's source code.

apps-script-utils 2.1.1 Help