symbol
Creates a symbol schema.
// Symbol schema with an optional message
const Schema = symbol(message);
Parameters
messageErrorMessage | undefined
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
Examples
The following examples show how symbol can be used.
Custom message
Symbol schema with a custom error message.
const schema = symbol('A symbol is required');
Related
The following APIs can be combined with symbol.
Schemas
array,intersect,lazy,map,nonNullable,nonNullish,nonOptional,nullable,nullish,object,optional,record,set,tuple,union