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,exactOptional,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,cache,config,fallback,flatten,forward,getDefault,getDefaults,getDescription,getExamples,getFallback,getFallbacks,getMetadata,getTitle,is,keyof,message,omit,parse,parser,partial,pick,pipe,required,safeParse,safeParser,summarize,unwrap
Actions
args,base64,bic,brand,bytes,check,checkItems,creditCard,cuid2,decimal,description,digits,domain,email,emoji,empty,endsWith,entries,everyItem,examples,excludes,filterItems,findItem,finite,flavor,graphemes,gtValue,guard,hash,hexadecimal,hexColor,imei,includes,integer,ip,ipv4,ipv6,isbn,isrc,isoDate,isoDateTime,isoDateTimeSecond,isoTime,isoTimeSecond,isoTimestamp,isoWeek,jwsCompact,length,ltValue,mac,mac48,mac64,mapItems,maxBytes,maxEntries,maxGraphemes,maxLength,maxSize,maxValue,maxWords,metadata,mimeType,minBytes,minEntries,minGraphemes,minLength,minSize,minValue,minWords,multipleOf,nanoid,nonEmpty,normalize,notBytes,notEntries,notGraphemes,notLength,notSize,notValue,notValues,notWords,octal,parseBoolean,parseJson,partialCheck,rawCheck,rawTransform,readonly,reduceItems,regex,returns,rfcEmail,safeInteger,size,slug,someItem,sortItems,startsWith,stringifyJson,title,toBigint,toBoolean,toCamelCase,toDate,toKebabCase,toLowerCase,toMaxValue,toMinValue,toNumber,toPascalCase,toSnakeCase,toString,toUpperCase,transform,trim,trimEnd,trimStart,ulid,url,uuid,value,values,words
Storages
deleteGlobalConfig,deleteGlobalMessage,deleteSchemaMessage,deleteSpecificMessage,getGlobalConfig,getGlobalMessage,getSchemaMessage,getSpecificMessage,setGlobalConfig,setGlobalMessage,setSchemaMessage,setSpecificMessage
Utils
Async
argsAsync,arrayAsync,awaitAsync,cacheAsync,checkAsync,checkItemsAsync,customAsync,exactOptionalAsync,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,ArgsActionAsync,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,Cache,CacheConfig,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,DomainAction,DomainIssue,EmailAction,EmailIssue,EmojiAction,EmojiIssue,EmptyAction,EmptyIssue,EndsWithAction,EndsWithIssue,EntriesAction,EntriesInput,EntriesIssue,Enum,EnumIssue,EnumSchema,ErrorMessage,EveryItemAction,EveryItemIssue,ExactOptionalSchema,ExactOptionalSchemaAsync,ExamplesAction,ExcludesAction,ExcludesIssue,FailureDataset,Fallback,FallbackAsync,FileIssue,FileSchema,FilterItemsAction,FindItemAction,FiniteAction,FiniteIssue,FirstTupleItem,FlatErrors,Flavor,FlavorAction,FlavorName,FunctionIssue,FunctionSchema,GenericIssue,GenericMetadata,GenericPipeAction,GenericPipeActionAsync,GenericPipeItem,GenericPipeItemAsync,GenericSchema,GenericSchemaAsync,GenericTransformation,GenericTransformationAsync,GenericValidation,GenericValidationAsync,GlobalConfig,GraphemesAction,GraphemesIssue,GtValueAction,GtValueIssue,GuardAction,GuardFunction,GuardIssue,HashAction,HashIssue,HashType,HexadecimalAction,HexadecimalIssue,HexColorAction,HexColorIssue,ImeiAction,ImeiIssue,IncludesAction,IncludesIssue,InferDefault,InferDefaults,InferExamples,InferFallback,InferFallbacks,InferGuardOutput,InferInput,InferIntersectInput,InferIntersectOutput,InferIssue,InferMapInput,InferMapOutput,InferMetadata,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,IsbnAction,IsbnIssue,IsrcAction,IsrcIssue,IsoDateAction,IsoDateIssue,IsoDateTimeAction,IsoDateTimeIssue,IsoDateTimeSecondAction,IsoDateTimeSecondIssue,IsoTimeAction,IsoTimeIssue,IsoTimeSecondAction,IsoTimeSecondIssue,IsoTimestampAction,IsoTimestampIssue,IsoWeekAction,IsoWeekIssue,IssueDotPath,IssuePathItem,JwsCompactAction,JwsCompactIssue,LastTupleItem,LazySchema,LazySchemaAsync,LengthAction,LengthInput,LengthIssue,Literal,LiteralIssue,LooseObjectIssue,LooseObjectSchema,LooseObjectSchemaAsync,LooseTupleIssue,LooseTupleSchema,LooseTupleSchemaAsync,LiteralSchema,LtValueAction,LtValueIssue,Mac48Action,Mac48Issue,Mac64Action,Mac64Issue,MacAction,MacIssue,MapIssue,MapItemsAction,MapPathItem,MapSchema,MapSchemaAsync,MaxBytesAction,MaxBytesIssue,MaxEntriesAction,MaxEntriesIssue,MaxGraphemesAction,MaxGraphemesIssue,MaxLengthAction,MaxLengthIssue,MaxSizeAction,MaxSizeIssue,MaxValueAction,MaxValueIssue,MaxWordsAction,MaxWordsIssue,MaybePromise,MaybeReadonly,MetadataAction,MimeTypeAction,MimeTypeIssue,MinBytesAction,MinBytesIssue,MinEntriesAction,MinEntriesIssue,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,NotEntriesAction,NotEntriesIssue,NotGraphemesAction,NotGraphemesIssue,NotLengthAction,NotLengthIssue,NotSizeAction,NotSizeIssue,NotValueAction,NotValuesAction,NotValueIssue,NotValuesIssue,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,ParseBooleanAction,ParseBooleanConfig,ParseBooleanIssue,ParseJsonAction,ParseJsonConfig,ParseJsonIssue,Parser,ParserAsync,PartialCheckAction,PartialCheckActionAsync,PartialCheckIssue,PartialDataset,PartialInput,Path,PicklistOptions,PicklistIssue,PicklistSchema,PipeAction,PipeActionAsync,PipeItem,PipeItemAsync,PromiseIssue,PromiseSchema,RawCheckAction,RawCheckActionAsync,RawCheckAddIssue,RawCheckContext,RawCheckIssue,RawCheckIssueInfo,RawTransformAction,RawTransformActionAsync,RawTransformAddIssue,RawTransformContext,RawTransformIssue,RawTransformIssueInfo,ReadonlyAction,RecordIssue,RecordSchema,RecordSchemaAsync,ReduceItemsAction,Reference,RegexAction,RegexIssue,RequiredPath,RequiredPaths,ReturnsAction,ReturnsActionAsync,RfcEmailAction,RfcEmailIssue,SafeIntegerAction,SafeIntegerIssue,SafeParser,SafeParserAsync,SafeParseResult,SchemaWithCache,SchemaWithCacheAsync,SchemaWithFallback,SchemaWithFallbackAsync,SchemaWithoutPipe,SchemaWithPartial,SchemaWithPartialAsync,SchemaWithPipe,SchemaWithPipeAsync,SchemaWithRequired,SchemaWithRequiredAsync,SetPathItem,SetIssue,SetSchema,SetSchemaAsync,SizeAction,SizeInput,SizeIssue,SlugAction,SlugIssue,SomeItemAction,SomeItemIssue,SortItemsAction,StandardFailureResult,StandardIssue,StandardPathItem,StandardProps,StandardResult,StandardSuccessResult,StandardTypes,StartsWithAction,StartsWithIssue,StrictObjectIssue,StrictObjectSchema,StrictObjectSchemaAsync,StrictTupleIssue,StrictTupleSchema,StrictTupleSchemaAsync,StringIssue,StringSchema,StringifyJsonAction,StringifyJsonConfig,StringifyJsonIssue,SuccessDataset,SymbolIssue,SymbolSchema,TitleAction,ToBigintAction,ToBigintIssue,ToBooleanAction,ToCamelCaseAction,ToDateAction,ToDateIssue,ToKebabCaseAction,ToLowerCaseAction,ToMaxValueAction,ToMinValueAction,ToNumberAction,ToNumberIssue,ToPascalCaseAction,ToSnakeCaseAction,ToStringAction,ToStringIssue,ToUpperCaseAction,TransformAction,TransformActionAsync,TrimAction,TrimEndAction,TrimStartAction,TupleIssue,TupleItems,TupleItemsAsync,TupleSchema,TupleSchemaAsync,TupleWithRestIssue,TupleWithRestSchema,TupleWithRestSchemaAsync,UlidAction,UlidIssue,UndefinedableSchema,UndefinedableSchemaAsync,UndefinedIssue,UndefinedSchema,UnionOptions,UnionOptionsAsync,UnionIssue,UnionSchema,UnionSchemaAsync,UnknownDataset,UnknownPathItem,UnknownSchema,UrlAction,UrlIssue,UuidAction,UuidIssue,ValueAction,ValuesAction,ValueInput,ValueIssue,ValuesIssue,VariantIssue,VariantOption,VariantOptionAsync,VariantOptions,VariantOptionsAsync,VariantSchema,VariantSchemaAsync,VoidIssue,VoidSchema,WordsAction,WordsIssue