symbol
Creates a symbol schema.
const Schema = v.symbol<TMessage>(message);
Generics
TMessageextends ErrorMessage<SymbolIssue> | undefined
Parameters
messageTMessage
Explanation
With symbol you can validate the data type of the input. If it is not a symbol, you can use message to customize the error message.
Returns
SchemaSymbolSchema<TMessage>
Examples
The following examples show how symbol can be used.
Custom message
Symbol schema with a custom error message.
const schema = v.symbol('A symbol is required');
Related
The following APIs can be combined with symbol.
Schemas
array,intersect,lazy,looseObject,looseTuple,map,nonNullable,nonNullish,nonOptional,nullable,nullish,object,objectWithRest,optional,record,set,strictObject,strictTuple,tuple,tupleWithRest,union
Methods
config,fallback,getDefault,getDefaults,getFallback,getFallbacks,is,parse,parser,pipe,safeParse,safeParser