bigint
Creates a bigint schema.
const Schema = v.bigint<TMessage>(message);
Generics
TMessageextends ErrorMessage<BigintIssue> | undefined
Parameters
messageTMessage
Explanation
With bigint you can validate the data type of the input. If the input is not a bigint, you can use message to customize the error message.
Returns
SchemaBigintSchema<TMessage>
Examples
The following examples show how bigint can be used.
Force minimum
Schema that forces a minimum bigint value.
const MinBigintSchema = v.pipe(v.bigint(), v.toMinValue(10n));
Validate maximum
Schema that validates a maximum bigint value.
const MaxBigintSchema = v.pipe(v.bigint(), v.maxValue(999n));
Related
The following APIs can be combined with bigint.
Schemas
array,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,parse,parser,pipe,safeParse,safeParser
Actions
check,brand,description,maxValue,metadata,minValue,notValue,rawCheck,rawTransform,readonly,title,toMaxValue,toMinValue,transform,value