Interface EnumSchema<S>

a schema that validates one of a set of strings

interface EnumSchema<S> {
    enum: S;
    metadata?: unknown;
    nullable?: boolean;
}

Type Parameters

S extends readonly [string, ...string[]] = readonly [string, ...string[]]

Index

Properties

enum metadata? nullable?

Properties

`Readonly` enum

enum: S

an array of all values allowed

`Optional` `Readonly` metadata

metadata?: unknown

optional metadata on a schema

`Optional` `Readonly` nullable

nullable?: boolean

a key indicating if a type can be null