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,date,enum_,instance,intersect,lazy,literal,map,nan,never,nonNullable,nonNullish,nonOptional,null_,nullable,nullish,number,object,optional,picklist,record,set,special,string,symbol,tuple,undefined_,union,unknown,variant,void_
Methods
brand,coerce,fallback,forward,getDefault,getDefaults,getFallback,getFallbacks,is,keyof,merge,omit,parse,partial,pick,required,safeParse,transform,unwrap
Validations
bic,bytes,creditCard,cuid2,custom,decimal,email,emoji,endsWith,every,excludes,finite,hash,hexadecimal,hexColor,imei,includes,integer,ip,ipv4,ipv6,isoDate,isoDateTime,isoTime,isoTimeSecond,isoTimestamp,isoWeek,length,mac,mac48,mac64,maxBytes,maxLength,maxSize,maxValue,mimeType,minBytes,minLength,minSize,minValue,multipleOf,notBytes,notLength,notSize,notValue,octal,regex,safeInteger,size,some,startsWith,ulid,url,uuid,value
Transformations
Error
Storages
deleteGlobalConfig,deleteGlobalMessage,deleteSchemaMessage,deleteSpecificMessage,getGlobalConfig,getGlobalMessage,getSchemaMessage,getSpecificMessage,setGlobalConfig,setGlobalMessage,setSchemaMessage,setSpecificMessage
Async
anyAsync,arrayAsync,bigintAsync,blobAsync,booleanAsync,coerceAsync,customAsync,dateAsync,enumAsync,fallbackAsync,forwardAsync,getDefaultAsync,getDefaultsAsync,getFallbackAsync,getFallbacksAsync,instanceAsync,intersectAsync,lazyAsync,literalAsync,mapAsync,mergeAsync,nanAsync,neverAsync,nonNullableAsync,nonNullishAsync,nonOptionalAsync,nullableAsync,nullishAsync,nullAsync,numberAsync,objectAsync,omitAsync,optionalAsync,parseAsync,partialAsync,pickAsync,picklistAsync,recordAsync,requiredAsync,safeParseAsync,setAsync,specialAsync,stringAsync,symbolAsync,toCustomAsync,transformAsync,tupleAsync,undefinedAsync,unionAsync,unknownAsync,variantAsync,voidAsync
Types
AnySchema,ArrayPathItem,ArraySchema,BaseSchema,BaseSchemaAsync,BaseTransformation,BaseTransformationAsync,BaseValidation,BaseValidationAsync,BicValidation,BigintSchema,BlobSchema,BooleanSchema,Brand,BrandName,BytesValidation,Class,CreditCardValidation,Cuid2Validation,CustomValidation,DateSchema,DecimalValidation,Default,DefaultAsync,DefaultValue,DefaultValues,EmailValidation,EmojiValidation,EndsWithValidation,Enum,EnumSchema,EnumSchemaAsync,ErrorMessage,EveryValidation,ExcludesValidation,Fallback,FallbackAsync,FallbackInfo,FallbackValue,FallbackValues,FiniteValidation,HashType,HashValidation,HexadecimalValidation,HexColorValidation,ImeiValidation,IncludesValidation,Input,InstanceSchema,IntegerValidation,IntersectInput,IntersectOptions,IntersectOutput,IntersectSchema,InvalidActionResult,Ipv4Validation,Ipv6Validation,IpValidation,IsoDateTimeValidation,IsoDateValidation,IsoTimeSecondValidation,IsoTimestampValidation,IsoTimeValidation,IsoWeekValidation,IssuePath,IssueReason,LazySchema,LengthValidation,Literal,LiteralSchema,Mac48Validation,Mac64Validation,MacValidation,MapInput,MapOutput,MapPathItem,MapSchema,MaxBytesValidation,MaxSizeValidation,MaxValueValidation,MaybeReadonly,MimeTypeValidation,MinBytesValidation,MinSizeValidation,MinValueValidation,MultipleOfValidation,NanSchema,NeverSchema,NonNullableInput,NonNullableOutput,NonNullableSchema,NonNullableSchemaAsync,NonNullishInput,NonNullishOutput,NonNullishSchema,NonNullishSchemaAsync,NonOptionalInput,NonOptionalOutput,NonOptionalSchema,NonOptionalSchemaAsync,NotBytesValidation,NotLengthValidation,NotSizeValidation,NotValueValidation,NullableSchema,NullableSchemaAsync,NullishSchema,NullishSchemaAsync,NullSchema,NumberSchema,ObjectEntries,ObjectEntriesAsync,ObjectInput,ObjectKeys,ObjectOutput,ObjectPathItem,ObjectSchema,ObjectSchemaAsync,OctalValidation,OptionalSchema,OptionalSchemaAsync,Output,PartialKeySchema,PartialObjectEntries,PathItem,PicklistOptions,PicklistSchema,PicklistSchemaAsync,Pipe,PipeActionContext,PipeActionIssue,PipeActionIssues,PipeActionResult,PipeAsync,RecordInput,RecordKey,RecordKeyAsync,RecordOutput,RecordPathItem,RecordSchema,RegexValidation,RequiredObjectEntries,SafeIntegerValidation,SafeParseResult,SchemaConfig,SchemaIssue,SchemaIssues,SchemaResult,SchemaWithBrand,SchemaWithFallback,SchemaWithMaybeDefault,SchemaWithMaybeDefaultAsync,SchemaWithMaybeFallback,SchemaWithMaybeFallbackAsync,SchemaWithTransform,SetInput,SetOutput,SetPathItem,SetSchema,SizeValidation,SomeValidation,SpecialSchema,SpecialSchemaAsync,StringSchema,StringSchemaAsync,StartsWithValidation,SymbolSchema,TransformInfo,TupleInput,TupleItems,TupleOutput,TuplePathItem,TupleSchema,TypedSchemaResult,UlidValidation,UndefinedSchema,UnionOptions,UnionOptionsAsync,UnionSchema,UnionSchemaAsync,UnknownPathItem,UnknownSchema,UntypedSchemaResult,UuidValidation,ValidActionResult,ValueValidation,VariantOption,VariantOptions,VariantSchema,VoidSchema