API reference
This section of our website contains detailed reference documentation for working with Valibot. Please create an issue if you are missing any information.
Schemas
any,array,bigint,blob,boolean,custom,date,enum,file,function,instance,intersect,lazy,literal,looseObject,looseTuple,map,nan,never,nonNullable,nonNullish,nonOptional,null,nullable,nullish,number,object,objectWithRest,optional,picklist,promise,record,set,strictObject,strictTuple,string,symbol,tuple,tupleWithRest,undefined,undefinedable,union,unknown,variant,void
Methods
assert,config,fallback,flatten,forward,getDefault,getDefaults,getFallback,getFallbacks,is,keyof,omit,parse,parser,partial,pick,pipe,required,safeParse,safeParser,unwrap
Actions
args,base64,bic,brand,bytes,check,checkItems,creditCard,cuid2,decimal,description,digits,email,emoji,empty,endsWith,everyItem,excludes,filterItems,findItem,finite,graphemes,hash,hexadecimal,hexColor,imei,includes,integer,ip,ipv4,ipv6,isoDate,isoDateTime,isoTime,isoTimeSecond,isoTimestamp,isoWeek,length,mac,mac48,mac64,mapItems,maxBytes,maxGraphemes,maxLength,maxSize,maxValue,maxWords,metadata,mimeType,minBytes,minGraphemes,minLength,minSize,minValue,minWords,multipleOf,nanoid,nonEmpty,normalize,notBytes,notGraphemes,notLength,notSize,notValue,notWords,octal,partialCheck,rawCheck,rawTransform,readonly,reduceItems,regex,returns,safeInteger,size,someItem,sortItems,startsWith,title,toLowerCase,toMaxValue,toMinValue,toUpperCase,transform,trim,trimEnd,trimStart,ulid,url,uuid,value,words
Storages
deleteGlobalConfig,deleteGlobalMessage,deleteSchemaMessage,deleteSpecificMessage,getGlobalConfig,getGlobalMessage,getSchemaMessage,getSpecificMessage,setGlobalConfig,setGlobalMessage,setSchemaMessage,setSpecificMessage
Utils
Async
argsAsync,arrayAsync,awaitAsync,checkAsync,checkItemsAsync,customAsync,fallbackAsync,forwardAsync,getDefaultsAsync,getFallbacksAsync,intersectAsync,lazyAsync,looseObjectAsync,looseTupleAsync,mapAsync,nonNullableAsync,nonNullishAsync,nonOptionalAsync,nullableAsync,nullishAsync,objectAsync,objectWithRestAsync,optionalAsync,parseAsync,parserAsync,partialAsync,partialCheckAsync,pipeAsync,rawCheckAsync,rawTransformAsync,recordAsync,requiredAsync,returnsAsync,safeParseAsync,safeParserAsync,setAsync,strictObjectAsync,strictTupleAsync,transformAsync,tupleAsync,tupleWithRestAsync,undefinedableAsync,unionAsync,variantAsync
Types
AnySchema,ArgsAction,ArrayInput,ArrayIssue,ArrayPathItem,ArrayRequirement,ArrayRequirementAsync,ArraySchema,ArraySchemaAsync,AwaitActionAsync,Base64Action,Base64Issue,BaseIssue,BaseMetadata,BaseSchema,BaseSchemaAsync,BaseTransformation,BaseTransformationAsync,BaseValidation,BaseValidationAsync,BicAction,BicIssue,BigintIssue,BigintSchema,BlobIssue,BlobSchema,BooleanIssue,BooleanSchema,Brand,BrandAction,BrandName,BytesAction,BytesIssue,CheckAction,CheckActionAsync,CheckIssue,CheckItemsAction,CheckItemsActionAsync,CheckItemsIssue,Class,Config,ContentInput,ContentRequirement,CreditCardAction,CreditCardIssue,Cuid2Action,Cuid2Issue,CustomIssue,CustomSchema,CustomSchemaAsync,DateIssue,DateSchema,DecimalAction,DecimalIssue,DeepPickN,Default,DefaultAsync,DefaultValue,DescriptionAction,DigitsAction,DigitsIssue,EmailAction,EmailIssue,EmojiAction,EmojiIssue,EmptyAction,EmptyIssue,EndsWithAction,EndsWithIssue,Enum,EnumIssue,EnumSchema,ErrorMessage,EveryItemAction,EveryItemIssue,ExcludesAction,ExcludesIssue,FailureDataset,Fallback,FallbackAsync,FileIssue,FileSchema,FilterItemsAction,FindItemAction,FiniteAction,FiniteIssue,FirstTupleItem,FlatErrors,FunctionIssue,FunctionSchema,GenericIssue,GenericMetadata,GenericSchema,GenericSchemaAsync,GenericTransformation,GenericTransformationAsync,GenericValidation,GenericValidationAsync,GlobalConfig,GraphemesAction,GraphemesIssue,HashAction,HashIssue,HashType,HexadecimalAction,HexadecimalIssue,HexColorAction,HexColorIssue,ImeiAction,ImeiIssue,IncludesAction,IncludesIssue,InferDefault,InferDefaults,InferFallback,InferFallbacks,InferInput,InferIntersectInput,InferIntersectOutput,InferIssue,InferMapInput,InferMapOutput,InferNonNullableInput,InferNonNullableIssue,InferNonNullableOutput,InferNonNullishInput,InferNonNullishIssue,InferNonNullishOutput,InferNonOptionalInput,InferNonOptionalIssue,InferNonOptionalOutput,InferNullableOutput,InferNullishOutput,InferObjectInput,InferObjectIssue,InferObjectOutput,InferOptionalOutput,InferOutput,InferRecordInput,InferRecordOutput,InferSetInput,InferSetOutput,InferTupleInput,InferTupleIssue,InferTupleOutput,InferVariantIssue,InstanceIssue,InstanceSchema,IntegerAction,IntegerIssue,IntersectIssue,IntersectOptions,IntersectOptionsAsync,IntersectSchema,IntersectSchemaAsync,IpAction,IpIssue,Ipv4Action,Ipv4Issue,Ipv6Action,Ipv6Issue,IsoDateAction,IsoDateIssue,IsoDateTimeAction,IsoDateTimeIssue,IsoTimeAction,IsoTimeIssue,IsoTimeSecondAction,IsoTimeSecondIssue,IsoTimestampAction,IsoTimestampIssue,IsoWeekAction,IsoWeekIssue,IssueDotPath,IssuePathItem,LazySchema,LazySchemaAsync,LengthAction,LengthInput,LengthIssue,Literal,LiteralIssue,LooseObjectIssue,LooseObjectSchema,LooseObjectSchemaAsync,LooseTupleIssue,LooseTupleSchema,LooseTupleSchemaAsync,LiteralSchema,Mac48Action,Mac48Issue,Mac64Action,Mac64Issue,MacAction,MacIssue,MapIssue,MapItemsAction,MapPathItem,MapSchema,MapSchemaAsync,MaxBytesAction,MaxBytesIssue,MaxGraphemesAction,MaxGraphemesIssue,MaxLengthAction,MaxLengthIssue,MaxSizeAction,MaxSizeIssue,MaxValueAction,MaxValueIssue,MaxWordsAction,MaxWordsIssue,MaybePromise,MaybeReadonly,MetadataAction,MimeTypeAction,MimeTypeIssue,MinBytesAction,MinBytesIssue,MinGraphemesAction,MinGraphemesIssue,MinLengthAction,MinLengthIssue,MinSizeAction,MinSizeIssue,MinValueAction,MinValueIssue,MinWordsAction,MinWordsIssue,MultipleOfAction,MultipleOfIssue,NanIssue,NanSchema,NeverIssue,NeverSchema,NonEmptyAction,NonEmptyIssue,NonNullable,NonNullableIssue,NonNullableSchema,NonNullableSchemaAsync,NonNullish,NonNullishIssue,NonNullishSchema,NonNullishSchemaAsync,NonOptional,NonOptionalIssue,NonOptionalSchema,NonOptionalSchemaAsync,NormalizeAction,NormalizeForm,NotBytesAction,NotBytesIssue,NotGraphemesAction,NotGraphemesIssue,NotLengthAction,NotLengthIssue,NotSizeAction,NotSizeIssue,NotValueAction,NotValueIssue,NotWordsAction,NotWordsIssue,NullableSchema,NullableSchemaAsync,NullishSchema,NullishSchemaAsync,NullIssue,NullSchema,NumberIssue,NumberSchema,ObjectEntries,ObjectEntriesAsync,ObjectIssue,ObjectKeys,ObjectPathItem,ObjectSchema,ObjectSchemaAsync,ObjectWithRestIssue,ObjectWithRestSchema,ObjectWithRestSchemaAsync,OctalAction,OctalIssue,OptionalSchema,OptionalSchemaAsync,OutputDataset,Parser,ParserAsync,PartialCheckAction,PartialCheckActionAsync,PartialCheckIssue,PartialDataset,PartialInput,PathKeys,PicklistOptions,PicklistIssue,PicklistSchema,PipeAction,PipeActionAsync,PipeItem,PipeItemAsync,PromiseIssue,PromiseSchema,RawCheckAction,RawCheckActionAsync,RawCheckIssue,RawTransformAction,RawTransformIssue,ReadonlyAction,RecordIssue,RecordSchema,RecordSchemaAsync,ReduceItemsAction,RegexAction,RegexIssue,ReturnsAction,SafeIntegerAction,SafeIntegerIssue,SafeParser,SafeParserAsync,SafeParseResult,SchemaWithFallback,SchemaWithFallbackAsync,SchemaWithoutPipe,SchemaWithPartial,SchemaWithPartialAsync,SchemaWithPipe,SchemaWithPipeAsync,SchemaWithRequired,SchemaWithRequiredAsync,SetPathItem,SetIssue,SetSchema,SetSchemaAsync,SizeAction,SizeInput,SizeIssue,SomeItemAction,SomeItemIssue,SortItemsAction,StartsWithAction,StartsWithIssue,StrictObjectIssue,StrictObjectSchema,StrictObjectSchemaAsync,StrictTupleIssue,StrictTupleSchema,StrictTupleSchemaAsync,StringIssue,StringSchema,SuccessDataset,SymbolIssue,SymbolSchema,TitleAction,ToLowerCaseAction,ToMaxValueAction,ToMinValueAction,ToUpperCaseAction,TransformAction,TrimAction,TrimEndAction,TrimStartAction,TupleIssue,TupleItems,TupleItemsAsync,TupleSchema,TupleSchemaAsync,TupleWithRestIssue,TupleWithRestSchema,TupleWithRestSchemaAsync,UlidAction,UlidIssue,UndefinedableSchema,UndefinedableSchemaAsync,UndefinedIssue,UndefinedSchema,UnionOptions,UnionOptionsAsync,UnionIssue,UnionSchema,UnionSchemaAsync,UnknownPathItem,UnknownSchema,UrlAction,UrlIssue,UuidAction,UuidIssue,ValueAction,ValueInput,ValueIssue,VariantIssue,VariantOptions,VariantOptionsAsync,VariantSchema,VariantSchemaAsync,VoidIssue,VoidSchema,WordsAction,WordsIssue