Deprecated
Use optional instead.
import { withDefault } from "https://deno.land/x/valibot@v0.24.0/src/index.ts";
Passes a default value to a schema in case of an undefined input.
Type Parameters
TSchema extends BaseSchema | BaseSchemaAsync
errormethodsschemastransformationstypesutilsvalidationsValiErrorAnySchemaAnySchemaAsyncArrayPathItemArraySchemaArraySchemaAsyncBaseSchemaBaseSchemaAsyncBaseTransformationBaseTransformationAsyncBaseValidationBaseValidationAsyncBicValidationBigintSchemaBigintSchemaAsyncBlobSchemaBlobSchemaAsyncBooleanSchemaBooleanSchemaAsyncBrandBrandNameBytesValidationClassCuid2ValidationCustomValidationCustomValidationAsyncDateSchemaDateSchemaAsyncDefaultValueDefaultValuesEmailValidationEmojiValidationEndsWithValidationEnumEnumSchemaEnumSchemaAsyncEqualValidationErrorMessageExcludesValidationFallbackInfoFallbackValueFallbackValuesFiniteValidationFlatErrorsImeiValidationIncludesValidationInputInstanceSchemaInstanceSchemaAsyncIntegerValidationIntersectOptionsIntersectSchemaInvalidActionResultIpv4ValidationIpv6ValidationIpValidationIsoDateTimeValidationIsoDateValidationIsoTimeSecondValidationIsoTimestampValidationIsoTimeValidationIsoWeekValidationIssueIssueOriginIssueReasonIssuesLengthValidationLiteralLiteralSchemaLiteralSchemaAsyncMac48ValidationMac64ValidationMacValidationMapInputMapOutputMapPathItemMapSchemaMapSchemaAsyncMaxBytesValidationMaxLengthValidationMaxSizeValidationMaxValueValidationMaybeReadonlyMimeTypeValidationMinBytesValidationMinLengthValidationMinSizeValidationMinValueValidationMultipleOfValidationNanSchemaNanSchemaAsyncNeverSchemaNeverSchemaAsyncNonNullableNonNullableSchemaNonNullableSchemaAsyncNonNullishNonNullishSchemaNonNullishSchemaAsyncNonOptionalNonOptionalSchemaNonOptionalSchemaAsyncNotBytesValidationNotLengthValidationNotSizeValidationNotValueValidationNullableSchemaNullableSchemaAsyncNullishSchemaNullishSchemaAsyncNullSchemaNullSchemaAsyncNumberSchemaNumberSchemaAsyncObjectEntriesObjectEntriesAsyncObjectInputObjectOutputObjectPathItemObjectSchemaObjectSchemaAsyncOptionalSchemaOptionalSchemaAsyncOutputParseInfoPartialObjectEntriesPartialObjectEntriesAsyncPathItemPicklistOptionsPicklistSchemaPicklistSchemaAsyncPipePipeActionResultPipeAsyncPipeInfoRecordInputRecordKeyRecordKeyAsyncRecordOutputRecordPathItemRecordSchemaRecordSchemaAsyncRecursiveSchemaRecursiveSchemaAsyncRegexValidationResolveObjectSafeIntegerValidationSafeParseResultSchemaResultSchemaWithBrandSchemaWithFallbackSchemaWithFallbackAsyncSchemaWithMaybeDefaultSchemaWithMaybeDefaultAsyncSchemaWithMaybeFallbackSchemaWithMaybeFallbackAsyncSchemaWithTransformSchemaWithTransformAsyncSetInputSetOutputSetPathItemSetSchemaSetSchemaAsyncSizeValidationSpecialSchemaSpecialSchemaAsyncStartsWithValidationStringSchemaStringSchemaAsyncSymbolSchemaSymbolSchemaAsyncToCustomTransformationToCustomTransformationAsyncToLowerCaseTransformationToMaxValueTransformationToMinValueTransformationToTrimmedEndTransformationToTrimmedStartTransformationToTrimmedTransformationToUpperCaseTransformationTupleInputTupleItemsTupleItemsAsyncTupleOutputTuplePathItemTupleSchemaTupleSchemaAsyncTypedSchemaResultUlidValidationUndefinedSchemaUndefinedSchemaAsyncUnionOptionsUnionOptionsAsyncUnionSchemaUnionSchemaAsyncUnknownPathItemUnknownSchemaUnknownSchemaAsyncUntypedSchemaResultUrlValidationUuidValidationValidActionResultValueValidationVariantOptionVariantOptionAsyncVariantOptionsVariantOptionsAsyncVariantSchemaVariantSchemaAsyncVoidSchemaVoidSchemaAsyncBIC_REGEXBrandSymbolCUID2_REGEXdiscriminatedUniondiscriminatedUnionAsyncEMAIL_REGEXEMOJI_REGEXenumTypeenumTypeAsyncIMEI_REGEXintersectionIPV4_REGEXIPV6_REGEXISO_DATE_REGEXISO_DATE_TIME_REGEXISO_TIME_REGEXISO_TIME_SECOND_REGEXISO_TIMESTAMP_REGEXISO_WEEK_REGEXMAC48_REGEXMAC64_REGEXmaxRangeminRangenativeEnumnativeEnumAsyncnullTypenullTypeAsyncULID_REGEXundefinedTypeundefinedTypeAsyncuseDefaultUUID_REGEXvoidTypevoidTypeAsyncactionIssueactionOutputanyanyAsyncarrayarrayAsyncbicbigintbigintAsyncblobblobAsyncbooleanbooleanAsyncbrandbytescoercecoerceAsynccuid2customcustomAsyncdatedateAsyncdefaultArgsemailemojiendsWithenum_enumAsyncequalexcludesfallbackfallbackAsyncfiniteflattenforwardgetDefaultgetDefaultAsyncgetDefaultsgetDefaultsAsyncgetFallbackgetFallbackAsyncgetFallbacksgetFallbacksAsyncimeiincludesinstanceinstanceAsyncintegerintersectipipv4ipv6isisLuhnAlgoisoDateisoDateTimeisoTimeisoTimeSecondisoTimestampisoWeekkeyoflengthliteralliteralAsyncmacmac48mac64mapmapAsyncmaxBytesmaxLengthmaxSizemaxValuemergemergeAsyncmimeTypeminBytesminLengthminSizeminValuemultipleOfnannanAsyncneverneverAsyncnonNullablenonNullableAsyncnonNullishnonNullishAsyncnonOptionalnonOptionalAsyncnotBytesnotLengthnotSizenotValuenull_nullablenullableAsyncnullAsyncnullishnullishAsyncnumbernumberAsyncobjectobjectAsyncomitomitAsyncoptionaloptionalAsyncparseparseAsyncparseResultpartialpartialAsyncpassthroughpassthroughAsyncpickpickAsyncpicklistpicklistAsyncpipeResultpipeResultAsyncrecordrecordAsyncrecursiverecursiveAsyncregexrequiredrequiredAsyncrestAndDefaultArgssafeIntegersafeParsesafeParseAsyncschemaIssuesetsetAsyncsizespecialspecialAsyncstartsWithstrictstrictAsyncstringstringAsyncstripstripAsyncsymbolsymbolAsynctoCustomtoCustomAsynctoLowerCasetoMaxValuetoMinValuetoTrimmedtoTrimmedEndtoTrimmedStarttoUpperCasetransformtransformAsynctupletupleAsynculidundefined_undefinedAsyncunionunionAsyncunknownunknownAsyncunwrapurluuidvaluevariantvariantAsyncvoid_voidAsyncwithDefault
index.ts (default module)
c
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
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
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
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