literal

Creates a literal schema.

const Schema = literal<TLiteral>(literal, message);

Generics

• TLiteral extends Literal

Parameters

• literal TLiteral
• message ErrorMessage | undefined

Explanation

With literal you can validate that the input matches a specified value. If the input is invalid, you can use message to customize the error message.

Returns

• Schema LiteralSchema<TLiteral>

Examples

The following examples show how literal can be used.

String literal

Schema to validate a string literal.

const StringLiteralSchema = literal('foo');

Number literal

Schema to validate a number literal.

const NumberLiteralSchema = literal(26);

Boolean literal

Schema to validate a boolean literal.

const BooleanLiteralSchema = literal(true);

Related

The following APIs can be combined with literal.

Schemas

• array,
• intersect,
• lazy,
• map,
• nonNullable,
• nonNullish,
• nonOptional,
• nullable,
• nullish,
• object,
• optional,
• record,
• set,
• tuple,
• union

Methods

• brand,
• coerce,
• fallback,
• getDefault,
• getDefaults,
• getFallback,
• getFallbacks,
• is,
• parse,
• safeParse,
• transform