null

Creates a null schema.

const Schema = v.null<TMessage>(message);

Generics

• TMessage extends ErrorMessage<NullIssue> | undefined

Parameters

• message TMessage

Explanation

With null you can validate the data type of the input and if it is not null, you can use message to customize the error message.

Returns

• Schema NullSchema<TMessage>

Related

The following APIs can be combined with null.

Schemas

array, exactOptional, intersect, lazy, looseObject, looseTuple, map, nonNullable, nonNullish, nonOptional, nullable, nullish, object, objectWithRest, optional, record, set, strictObject, strictTuple, tuple, tupleWithRest, undefinedable, union

Methods

assert, config, fallback, getDefault, getDefaults, getFallback, getFallbacks, is, message, parse, parser, pipe, safeParse, safeParser

Actions

check, brand, description, flavor, guard, metadata, rawCheck, rawTransform, readonly, title, transform

Utils

entriesFromList, isOfKind, isOfType