import { type UnionSchema } from "https://deno.land/x/valibot@v0.30.0/mod.ts";
Union schema type.
Type Parameters
TOptions extends UnionOptions
Properties
options: TOptions
The union options.
message: ErrorMessage | undefined
The error message.
Module
The modular and type safe schema library for validating structural data 🤖
Extremely Popular
srcValiErrorAnySchemaAnySchemaAsyncArrayPathItemArraySchemaArraySchemaAsyncBaseSchemaBaseSchemaAsyncBaseTransformationBaseTransformationAsyncBaseValidationBaseValidationAsyncBicValidationBigintSchemaBigintSchemaAsyncBlobSchemaBlobSchemaAsyncBooleanSchemaBooleanSchemaAsyncBrandBytesValidationCreditCardValidationCuid2ValidationCustomValidationCustomValidationAsyncDateSchemaDateSchemaAsyncDecimalValidationEmailValidationEmojiValidationEndsWithValidationEnumEnumSchemaEnumSchemaAsyncEveryValidationExcludesValidationFallbackInfoFiniteValidationFlatErrorsHashValidationHexadecimalValidationHexColorValidationImeiValidationIncludesValidationInstanceSchemaInstanceSchemaAsyncIntegerValidationIntersectSchemaIntersectSchemaAsyncInvalidActionResultIpv4ValidationIpv6ValidationIpValidationIsoDateTimeValidationIsoDateValidationIsoTimeSecondValidationIsoTimestampValidationIsoTimeValidationIsoWeekValidationLazySchemaLazySchemaAsyncLengthValidationLiteralSchemaLiteralSchemaAsyncMac48ValidationMac64ValidationMacValidationMapPathItemMapSchemaMapSchemaAsyncMaxBytesValidationMaxLengthValidationMaxSizeValidationMaxValueValidationMimeTypeValidationMinBytesValidationMinLengthValidationMinSizeValidationMinValueValidationMultipleOfValidationNanSchemaNanSchemaAsyncNeverSchemaNeverSchemaAsyncNonNullableSchemaNonNullableSchemaAsyncNonNullishSchemaNonNullishSchemaAsyncNonOptionalSchemaNonOptionalSchemaAsyncNotBytesValidationNotLengthValidationNotSizeValidationNotValueValidationNullableSchemaNullableSchemaAsyncNullishSchemaNullishSchemaAsyncNullSchemaNullSchemaAsyncNumberSchemaNumberSchemaAsyncObjectEntriesObjectEntriesAsyncObjectPathItemObjectSchemaObjectSchemaAsyncOctalValidationOptionalSchemaOptionalSchemaAsyncPicklistSchemaPicklistSchemaAsyncPipeActionContextPipeActionIssueRecordPathItemRecordSchemaRecordSchemaAsyncRegexValidationSafeIntegerValidationSchemaConfigSchemaIssueSetPathItemSetSchemaSetSchemaAsyncSizeValidationSomeValidationSpecialSchemaSpecialSchemaAsyncStartsWithValidationStringSchemaStringSchemaAsyncSymbolSchemaSymbolSchemaAsyncToCustomTransformationToCustomTransformationAsyncToLowerCaseTransformationToMaxValueTransformationToMinValueTransformationToTrimmedEndTransformationToTrimmedStartTransformationToTrimmedTransformationToUpperCaseTransformationTuplePathItemTupleSchemaTupleSchemaAsyncTypedSchemaResultUlidValidationUndefinedSchemaUndefinedSchemaAsyncUnionSchemaUnionSchemaAsyncUnknownPathItemUnknownSchemaUnknownSchemaAsyncUntypedSchemaResultUrlValidationUuidValidationValidActionResultValueValidationVariantSchemaVariantSchemaAsyncVoidSchemaVoidSchemaAsyncBrandNameClassDefaultDefaultAsyncDefaultValueDefaultValuesErrorMessageFallbackFallbackAsyncFallbackValueFallbackValuesGlobalConfigHashTypeInputIntersectOptionsIntersectOptionsAsyncIssuePathIssueReasonLiteralMapInputMapOutputMaybePromiseMaybeReadonlyNonNullableInputNonNullableOutputNonNullishInputNonNullishOutputNonOptionalInputNonOptionalOutputObjectInputObjectKeysObjectOutputOutputPartialObjectEntriesPartialObjectEntriesAsyncPathItemPathListPicklistOptionsPipePipeActionIssuesPipeActionResultPipeAsyncRecordInputRecordKeyRecordKeyAsyncRecordOutputResolveObjectSafeParseResultSchemaIssuesSchemaResultSchemaWithBrandSchemaWithFallbackSchemaWithFallbackAsyncSchemaWithMaybeDefaultSchemaWithMaybeDefaultAsyncSchemaWithMaybeFallbackSchemaWithMaybeFallbackAsyncSchemaWithTransformSchemaWithTransformAsyncSetInputSetOutputTupleInputTupleItemsTupleItemsAsyncTupleOutputUnionOptionsUnionOptionsAsyncVariantOptionVariantOptionAsyncVariantOptionsVariantOptionsAsyncBIC_REGEXBrandSymbolCUID2_REGEXDECIMAL_REGEXEMAIL_REGEXEMOJI_REGEXHEX_COLOR_REGEXHEXADECIMAL_REGEXIMEI_REGEXIPV4_REGEXIPV6_REGEXISO_DATE_REGEXISO_DATE_TIME_REGEXISO_TIME_REGEXISO_TIME_SECOND_REGEXISO_TIMESTAMP_REGEXISO_WEEK_REGEXMAC48_REGEXMAC64_REGEXOCTAL_REGEXULID_REGEXUUID_REGEXactionIssueactionOutputanyanyAsyncarrayarrayAsyncbicbigintbigintAsyncblobblobAsyncbooleanbooleanAsyncbrandbytescoercecoerceAsynccreditCardcuid2customcustomAsyncdatedateAsyncdecimaldefaultArgsdeleteGlobalConfigdeleteGlobalMessagedeleteSchemaMessagedeleteSpecificMessageemailemojiendsWithenum_enumAsynceveryexcludesfallbackfallbackAsyncfiniteflattenforwardforwardAsyncgetDefaultgetDefaultAsyncgetDefaultsgetDefaultsAsyncgetFallbackgetFallbackAsyncgetFallbacksgetFallbacksAsyncgetGlobalConfiggetGlobalMessagegetSchemaMessagegetSpecificMessagehashhexadecimalhexColori18nimeiincludesinstanceinstanceAsyncintegerintersectintersectAsyncipipv4ipv6isisLuhnAlgoisoDateisoDateTimeisOfTypeisoTimeisoTimeSecondisoTimestampisoWeekkeyoflazylazyAsynclengthliteralliteralAsyncmacmac48mac64mapmapAsyncmaxBytesmaxLengthmaxSizemaxValuemergemergeAsyncmimeTypeminBytesminLengthminSizeminValuemultipleOfnannanAsyncneverneverAsyncnonNullablenonNullableAsyncnonNullishnonNullishAsyncnonOptionalnonOptionalAsyncnotBytesnotLengthnotSizenotValuenull_nullablenullableAsyncnullAsyncnullishnullishAsyncnumbernumberAsyncobjectobjectAsyncoctalomitomitAsyncoptionaloptionalAsyncparseparseAsyncpartialpartialAsyncpickpickAsyncpicklistpicklistAsyncpipeResultpipeResultAsyncrecordrecordAsyncregexrequiredrequiredAsyncrestAndDefaultArgssafeIntegersafeParsesafeParseAsyncschemaIssueschemaResultsetsetAsyncsetGlobalConfigsetGlobalMessagesetSchemaMessagesetSpecificMessagesizesomespecialspecialAsyncstartsWithstringstringAsyncstringifysymbolsymbolAsynctoCustomtoCustomAsynctoLowerCasetoMaxValuetoMinValuetoTrimmedtoTrimmedEndtoTrimmedStarttoUpperCasetransformtransformAsynctupletupleAsynculidundefined_undefinedAsyncunionunionAsyncunknownunknownAsyncunwrapurluuidvaluevariantvariantAsyncvoid_voidAsync
mod.ts (default module)
c
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f