Skip to content

enums

function enums<T extends readonly string[]>(values: T): EnumPrimitive<T>

Creates a primitive that accepts any string value present in the provided tuple.

values T

returns EnumPrimitive<T>

Example:

const role = enums(["admin", "user", "guest"]);

Throws:

When the raw value fails this primitive’s validation.

Learn: Primitives and builders

Last updated: