Zod SemVer

A simple deno module by @codemonument with a zod schema for validating semver. Uses official regex.

Published to:

• deno.land
• npm
• jsr

Usage

Import in Deno

import {ZodSemver} from 'https://deno.land/x/zod_semver/mod.ts';

Import in Node

import {ZodSemver} from 'zod-semver';

Usage after Import

// Use like any other Zod Schema:
ZodSemver.parse('1.0.0');

// Or include in another Zod Schema like this:

const MyObjectSchema = z.object({
    version: ZodSemver,
    name: z.string(),
    age: z.number().optional(),
});

Using the branded ZodSemver type

At it’s base, the ZodSemver type is simply a more refined string. So the TS type for it is string. However, sometimes it might be useful for a function to make sure that it only receives an already parsed semver string. This is possible via the branded ZodSemver type.

‘branded’ means that the type is a string, but with a special property atached that makes it unique. See the zod docs for more information: https://zod.dev/?id=brand

Links

Changelog

1.2.0

• upgrade zod to 3.22.2
• add test for using ZodSemver branded type in an optional union with ‘latest’ string and with ‘latest’ as default

As Fallback:

• add ZodSemverUnbranded even though it only types to string, but the parsing is still attached and returns string, instead of returning the kind-of-special ‘branded’ type ZodSemver This may allow easier combination with certain context requirements when using this ZodSemver library, for example: using this semver in a union with “latest”

1.1.0

• Added the branded type ZodSemver for use in functions that require a parsed semver string

1.0.2

small fixes

1.0.1

small fixes

1.0.0

initial release