Deprecated
Use optional instead.
import { withDefault } from "https://deno.land/x/valibot@v0.28.1/src/index.ts";
Passes a default value to a schema in case of an undefined input.
Type Parameters
TSchema extends BaseSchema | BaseSchemaAsync
Module
x/valibot/src/index.ts>withDefault
The modular and type safe schema library for validating structural data 🤖
Extremely Popular
errormethodsschemasstoragestransformationstypesutilsvalidationsValiErrorAnySchemaAnySchemaAsyncArrayPathItemArraySchemaArraySchemaAsyncBaseSchemaBaseSchemaAsyncBaseTransformationBaseTransformationAsyncBaseValidationBaseValidationAsyncBicValidationBigintSchemaBigintSchemaAsyncBlobSchemaBlobSchemaAsyncBooleanSchemaBooleanSchemaAsyncBrandBrandNameBytesValidationClassCreditCardValidationCuid2ValidationCustomValidationCustomValidationAsyncDateSchemaDateSchemaAsyncDecimalValidationDefaultValueDefaultValuesEmailValidationEmojiValidationEndsWithValidationEnumEnumSchemaEnumSchemaAsyncEqualValidationErrorMessageExcludesValidationFallbackInfoFallbackValueFallbackValuesFiniteValidationFlatErrorsGlobalConfigHashTypeHashValidationHexadecimalValidationHexColorValidationImeiValidationIncludesValidationInputInstanceSchemaInstanceSchemaAsyncIntegerValidationIntersectOptionsIntersectSchemaInvalidActionResultIpv4ValidationIpv6ValidationIpValidationIsoDateTimeValidationIsoDateValidationIsoTimeSecondValidationIsoTimestampValidationIsoTimeValidationIsoWeekValidationIssuePathIssueReasonLengthValidationLiteralLiteralSchemaLiteralSchemaAsyncMac48ValidationMac64ValidationMacValidationMapInputMapOutputMapPathItemMapSchemaMapSchemaAsyncMaxBytesValidationMaxLengthValidationMaxSizeValidationMaxValueValidationMaybeReadonlyMimeTypeValidationMinBytesValidationMinLengthValidationMinSizeValidationMinValueValidationMultipleOfValidationNanSchemaNanSchemaAsyncNeverSchemaNeverSchemaAsyncNonNullableInputNonNullableOutputNonNullableSchemaNonNullableSchemaAsyncNonNullishInputNonNullishOutputNonNullishSchemaNonNullishSchemaAsyncNonOptionalInputNonOptionalOutputNonOptionalSchemaNonOptionalSchemaAsyncNotBytesValidationNotLengthValidationNotSizeValidationNotValueValidationNullableSchemaNullableSchemaAsyncNullishSchemaNullishSchemaAsyncNullSchemaNullSchemaAsyncNumberSchemaNumberSchemaAsyncObjectEntriesObjectEntriesAsyncObjectInputObjectKeysObjectOutputObjectPathItemObjectSchemaObjectSchemaAsyncOctalValidationOptionalSchemaOptionalSchemaAsyncOutputPartialObjectEntriesPartialObjectEntriesAsyncPathItemPathListPicklistOptionsPicklistSchemaPicklistSchemaAsyncPipePipeActionContextPipeActionIssuePipeActionIssuesPipeActionResultPipeAsyncRecordInputRecordKeyRecordKeyAsyncRecordOutputRecordPathItemRecordSchemaRecordSchemaAsyncRecursiveSchemaRecursiveSchemaAsyncRegexValidationResolveObjectSafeIntegerValidationSafeParseResultSchemaConfigSchemaIssueSchemaIssuesSchemaResultSchemaWithBrandSchemaWithFallbackSchemaWithFallbackAsyncSchemaWithMaybeDefaultSchemaWithMaybeDefaultAsyncSchemaWithMaybeFallbackSchemaWithMaybeFallbackAsyncSchemaWithTransformSchemaWithTransformAsyncSetInputSetOutputSetPathItemSetSchemaSetSchemaAsyncSizeValidationSpecialSchemaSpecialSchemaAsyncStartsWithValidationStringSchemaStringSchemaAsyncSymbolSchemaSymbolSchemaAsyncToCustomTransformationToCustomTransformationAsyncToLowerCaseTransformationToMaxValueTransformationToMinValueTransformationToTrimmedEndTransformationToTrimmedStartTransformationToTrimmedTransformationToUpperCaseTransformationTupleInputTupleItemsTupleItemsAsyncTupleOutputTuplePathItemTupleSchemaTupleSchemaAsyncTypedSchemaResultUlidValidationUndefinedSchemaUndefinedSchemaAsyncUnionOptionsUnionOptionsAsyncUnionSchemaUnionSchemaAsyncUnknownPathItemUnknownSchemaUnknownSchemaAsyncUntypedSchemaResultUrlValidationUuidValidationValidActionResultValueValidationVariantOptionVariantOptionAsyncVariantOptionsVariantOptionsAsyncVariantSchemaVariantSchemaAsyncVoidSchemaVoidSchemaAsyncBIC_REGEXBrandSymbolCUID2_REGEXDECIMAL_REGEXdiscriminatedUniondiscriminatedUnionAsyncEMAIL_REGEXEMOJI_REGEXenumTypeenumTypeAsyncHEX_COLOR_REGEXHEXADECIMAL_REGEXIMEI_REGEXintersectionIPV4_REGEXIPV6_REGEXISO_DATE_REGEXISO_DATE_TIME_REGEXISO_TIME_REGEXISO_TIME_SECOND_REGEXISO_TIMESTAMP_REGEXISO_WEEK_REGEXMAC48_REGEXMAC64_REGEXmaxRangeminRangenativeEnumnativeEnumAsyncnullTypenullTypeAsyncOCTAL_REGEXULID_REGEXundefinedTypeundefinedTypeAsyncuseDefaultUUID_REGEXvoidTypevoidTypeAsyncactionIssueactionOutputanyanyAsyncarrayarrayAsyncbicbigintbigintAsyncblobblobAsyncbooleanbooleanAsyncbrandbytescoercecoerceAsynccreditCardcuid2customcustomAsyncdatedateAsyncdecimaldefaultArgsdeleteGlobalConfigdeleteGlobalMessagedeleteSchemaMessagedeleteSpecificMessageemailemojiendsWithenum_enumAsyncequalexcludesfallbackfallbackAsyncfiniteflattenforwardforwardAsyncgetDefaultgetDefaultAsyncgetDefaultsgetDefaultsAsyncgetFallbackgetFallbackAsyncgetFallbacksgetFallbacksAsyncgetGlobalConfiggetGlobalMessagegetSchemaMessagegetSpecificMessagehashhexadecimalhexColori18nimeiincludesinstanceinstanceAsyncintegerintersectipipv4ipv6isisLuhnAlgoisoDateisoDateTimeisoTimeisoTimeSecondisoTimestampisoWeekkeyoflengthliteralliteralAsyncmacmac48mac64mapmapAsyncmaxBytesmaxLengthmaxSizemaxValuemergemergeAsyncmimeTypeminBytesminLengthminSizeminValuemultipleOfnannanAsyncneverneverAsyncnonNullablenonNullableAsyncnonNullishnonNullishAsyncnonOptionalnonOptionalAsyncnotBytesnotLengthnotSizenotValuenull_nullablenullableAsyncnullAsyncnullishnullishAsyncnumbernumberAsyncobjectobjectAsyncoctalomitomitAsyncoptionaloptionalAsyncparseparseAsyncpartialpartialAsyncpassthroughpassthroughAsyncpickpickAsyncpicklistpicklistAsyncpipeResultpipeResultAsyncrecordrecordAsyncrecursiverecursiveAsyncregexrequiredrequiredAsyncrestAndDefaultArgssafeIntegersafeParsesafeParseAsyncschemaIssueschemaResultsetsetAsyncsetGlobalConfigsetGlobalMessagesetSchemaMessagesetSpecificMessagesizespecialspecialAsyncstartsWithstrictstrictAsyncstringstringAsyncstringifystripstripAsyncsymbolsymbolAsynctoCustomtoCustomAsynctoLowerCasetoMaxValuetoMinValuetoTrimmedtoTrimmedEndtoTrimmedStarttoUpperCasetransformtransformAsynctupletupleAsynculidundefined_undefinedAsyncunionunionAsyncunknownunknownAsyncunwrapurluuidvaluevariantvariantAsyncvoid_voidAsyncwithDefaultBIC_REGEXCUID2_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_REGEX
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
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
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
f
f
f
f
regex.ts
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v