Literal

Primitive values are all well and good, but sometimes we want a specific value of type string, rather than any string. All primitive types — except null and undefined, as they can only ever have one value — are compatible with the literal schema.

Playground

Schema

Data

Result

String literal

import * as p from '@vbudovski/paseri';

const schema = p.literal('foo');
const data = 'foo';

const result = schema.safeParse(data);
if (result.ok) {
    // result.value typed as `'foo'`.
}

Number literal

import * as p from '@vbudovski/paseri';

const schema = p.literal(123);
const data = 123;

const result = schema.safeParse(data);
if (result.ok) {
    // result.value typed as `123`.
}

BigInt literal

import * as p from '@vbudovski/paseri';

const schema = p.literal(456n);
const data = 456n;

const result = schema.safeParse(data);
if (result.ok) {
    // result.value typed as `456n`.
}

Boolean literal

import * as p from '@vbudovski/paseri';

const schema = p.literal(true);
const data = true;

const result = schema.safeParse(data);
if (result.ok) {
    // result.value typed as `true`.
}

Symbol literal

import * as p from '@vbudovski/paseri';

const symbolLiteral = Symbol.for('bar');
const schema = p.literal(symbolLiteral);
const data = Symbol.for('bar');

const result = schema.safeParse(data);
if (result.ok) {
    // result.value typed as `unique symbol`.
}