import { type StringSchema } from "https://deno.land/x/valibot@v0.35.0/src/index.ts";
String schema type.
Type Parameters
TMessage extends ErrorMessage<StringIssue> | undefined
Properties
readonly
message: TMessageThe error message.
Module
x/valibot/src/index.ts>StringSchema
The modular and type safe schema library for validating structural data 🤖
Extremely Popular
actionsmethodsschemasstoragestypesutilsvitestValiErrorAnySchemaArrayIssueArrayPathItemArraySchemaArraySchemaAsyncAwaitActionAsyncBaseIssueBaseSchemaBaseSchemaAsyncBaseTransformationBaseTransformationAsyncBaseValidationBaseValidationAsyncBicActionBicIssueBigintIssueBigintSchemaBlobIssueBlobSchemaBooleanIssueBooleanSchemaBrandBrandActionBytesActionBytesIssueCheckActionCheckActionAsyncCheckIssueCheckItemsActionCheckItemsIssueConfigCreditCardActionCreditCardIssueCuid2ActionCuid2IssueCustomIssueCustomSchemaCustomSchemaAsyncDateIssueDateSchemaDecimalActionDecimalIssueEmailActionEmailIssueEmojiActionEmojiIssueEmptyActionEmptyIssueEndsWithActionEndsWithIssueEnumEnumIssueEnumSchemaEveryItemActionEveryItemIssueExcludesActionExcludesIssueFileIssueFileSchemaFilterItemsActionFindItemActionFiniteActionFiniteIssueFunctionIssueFunctionSchemaGenericIssueGenericSchemaGenericSchemaAsyncGenericTransformationGenericTransformationAsyncGenericValidationGenericValidationAsyncHashActionHashIssueHexadecimalActionHexadecimalIssueHexColorActionHexColorIssueImeiActionImeiIssueIncludesActionIncludesIssueInstanceIssueInstanceSchemaIntegerActionIntegerIssueIntersectIssueIntersectSchemaIntersectSchemaAsyncIpActionIpIssueIpv4ActionIpv4IssueIpv6ActionIpv6IssueIsoDateActionIsoDateIssueIsoDateTimeActionIsoDateTimeIssueIsoTimeActionIsoTimeIssueIsoTimeSecondActionIsoTimeSecondIssueIsoTimestampActionIsoTimestampIssueIsoWeekActionIsoWeekIssueLazySchemaLazySchemaAsyncLengthActionLengthIssueLiteralIssueLiteralSchemaLooseObjectIssueLooseObjectSchemaLooseObjectSchemaAsyncLooseTupleIssueLooseTupleSchemaLooseTupleSchemaAsyncMac48ActionMac48IssueMac64ActionMac64IssueMacActionMacIssueMapIssueMapItemsActionMapPathItemMapSchemaMapSchemaAsyncMaxBytesActionMaxBytesIssueMaxLengthActionMaxLengthIssueMaxSizeActionMaxSizeIssueMaxValueActionMaxValueIssueMimeTypeActionMimeTypeIssueMinBytesActionMinBytesIssueMinLengthActionMinLengthIssueMinSizeActionMinSizeIssueMinValueActionMinValueIssueMultipleOfActionMultipleOfIssueNanIssueNanSchemaNeverIssueNeverSchemaNonEmptyActionNonEmptyIssueNonNullableIssueNonNullableSchemaNonNullableSchemaAsyncNonNullishIssueNonNullishSchemaNonNullishSchemaAsyncNonOptionalIssueNonOptionalSchemaNonOptionalSchemaAsyncNotBytesActionNotBytesIssueNotLengthActionNotLengthIssueNotSizeActionNotSizeIssueNotValueActionNotValueIssueNullableSchemaNullableSchemaAsyncNullishSchemaNullishSchemaAsyncNullIssueNullSchemaNumberIssueNumberSchemaObjectEntriesObjectEntriesAsyncObjectIssueObjectPathItemObjectSchemaObjectSchemaAsyncObjectWithRestIssueObjectWithRestSchemaObjectWithRestSchemaAsyncOctalActionOctalIssueOptionalSchemaOptionalSchemaAsyncParserParserAsyncPartialCheckActionPartialCheckActionAsyncPartialCheckIssuePicklistIssuePicklistSchemaPromiseIssuePromiseSchemaRawCheckActionRawCheckActionAsyncRawCheckIssueRawTransformActionRawTransformActionAsyncRawTransformIssueReadonlyActionRecordIssueRecordSchemaRecordSchemaAsyncReduceItemsActionRegexActionRegexIssueSafeIntegerActionSafeIntegerIssueSafeParserSafeParserAsyncSetIssueSetPathItemSetSchemaSetSchemaAsyncSizeActionSizeIssueSomeItemActionSomeItemIssueSortItemsActionStartsWithActionStartsWithIssueStrictObjectIssueStrictObjectSchemaStrictObjectSchemaAsyncStrictTupleIssueStrictTupleSchemaStrictTupleSchemaAsyncStringIssueStringSchemaSymbolIssueSymbolSchemaToLowerCaseActionToMaxValueActionToMinValueActionToUpperCaseActionTransformActionTransformActionAsyncTrimActionTrimEndActionTrimStartActionTupleIssueTupleSchemaTupleSchemaAsyncTupleWithRestIssueTupleWithRestSchemaTupleWithRestSchemaAsyncTypedDatasetUlidActionUlidIssueUndefinedIssueUndefinedSchemaUnionIssueUnionSchemaUnionSchemaAsyncUnknownPathItemUnknownSchemaUntypedDatasetUrlActionUrlIssueUuidActionUuidIssueValueActionValueIssueVariantIssueVariantSchemaVariantSchemaAsyncVoidIssueVoidSchemaArrayRequirementBrandNameClassContentInputContentRequirementDatasetDeepPickNDefaultDefaultAsyncDefaultValueErrorMessageFallbackFallbackAsyncFirstTupleItemFlatErrorsFunctionReferenceGlobalConfigHashTypeInferDefaultInferDefaultsInferFallbackInferFallbacksInferInputInferIntersectInputInferIntersectOutputInferIssueInferMapInputInferMapOutputInferNonNullableInputInferNonNullableIssueInferNonNullableOutputInferNonNullishInputInferNonNullishIssueInferNonNullishOutputInferNonOptionalInputInferNonOptionalIssueInferNonOptionalOutputInferNullableOutputInferNullishOutputInferObjectInputInferObjectIssueInferObjectOutputInferOptionalOutputInferOutputInferRecordInputInferRecordOutputInferSetInputInferSetOutputInferTupleInputInferTupleIssueInferTupleOutputInferVariantIssueIntersectOptionsIntersectOptionsAsyncIssueDotPathIssuePathItemLastTupleItemLengthInputLiteralMarkOptionalMaybePromiseMaybeReadonlyNonNullableNonNullishNonOptionalNoPipeObjectKeysPathKeysPicklistOptionsPipeActionPipeActionAsyncPipeItemPipeItemAsyncPrettifyQuestionMarkSchemaQuestionMarkSchemaAsyncSafeParseResultSchemaWithFallbackSchemaWithFallbackAsyncSchemaWithOmitSchemaWithPartialSchemaWithPartialAsyncSchemaWithPickSchemaWithPipeSchemaWithPipeAsyncSchemaWithRequiredSchemaWithRequiredAsyncSizeInputTupleItemsTupleItemsAsyncUnionOptionsUnionOptionsAsyncUnionToIntersectUnionToTupleValueInputVariantOptionsVariantOptionsAsyncBIC_REGEXBrandSymbolCUID2_REGEXDECIMAL_REGEXEMAIL_REGEXEMOJI_REGEXHEX_COLOR_REGEXHEXADECIMAL_REGEXIMEI_REGEXIP_REGEXIPV4_REGEXIPV6_REGEXISO_DATE_REGEXISO_DATE_TIME_REGEXISO_TIME_REGEXISO_TIME_SECOND_REGEXISO_TIMESTAMP_REGEXISO_WEEK_REGEXMAC_REGEXMAC48_REGEXMAC64_REGEXOCTAL_REGEXULID_REGEXUUID_REGEX_addIssue_isLuhnAlgo_isValidObjectKey_stringifyanyarrayarrayAsyncawaitAsyncbicbigintblobbooleanbrandbytescheckcheckAsynccheckItemsconfigcreditCardcuid2customcustomAsyncdatedecimaldeleteGlobalConfigdeleteGlobalMessagedeleteSchemaMessagedeleteSpecificMessageemailemojiemptyendsWithentriesFromListenumenum_everyItemexcludesfallbackfallbackAsyncfilefilterItemsfindItemfiniteflattenforwardforwardAsyncfunctionfunction_getDefaultgetDefaultsgetDefaultsAsyncgetDotPathgetFallbackgetFallbacksgetFallbacksAsyncgetGlobalConfiggetGlobalMessagegetSchemaMessagegetSpecificMessagehashhexadecimalhexColorimeiincludesinstanceintegerintersectintersectAsyncipipv4ipv6isisoDateisoDateTimeisOfKindisOfTypeisoTimeisoTimeSecondisoTimestampisoWeekisValiErrorkeyoflazylazyAsynclengthliterallooseObjectlooseObjectAsynclooseTuplelooseTupleAsyncmacmac48mac64mapmapAsyncmapItemsmaxBytesmaxLengthmaxSizemaxValuemimeTypeminBytesminLengthminSizeminValuemultipleOfnannevernonEmptynonNullablenonNullableAsyncnonNullishnonNullishAsyncnonOptionalnonOptionalAsyncnotBytesnotLengthnotSizenotValuenullnull_nullablenullableAsyncnullishnullishAsyncnumberobjectobjectAsyncobjectWithRestobjectWithRestAsyncoctalomitoptionaloptionalAsyncparseparseAsyncparserparserAsyncpartialpartialAsyncpartialCheckpartialCheckAsyncpickpicklistpipepipeAsyncpromiserawCheckrawCheckAsyncrawTransformrawTransformAsyncreadonlyrecordrecordAsyncreduceItemsregexrequiredrequiredAsyncsafeIntegersafeParsesafeParseAsyncsafeParsersafeParserAsyncsetsetAsyncsetGlobalConfigsetGlobalMessagesetSchemaMessagesetSpecificMessagesizesomeItemsortItemsstartsWithstrictObjectstrictObjectAsyncstrictTuplestrictTupleAsyncstringsymboltoLowerCasetoMaxValuetoMinValuetoUpperCasetransformtransformAsynctrimtrimEndtrimStarttupletupleAsynctupleWithResttupleWithRestAsynculidundefinedundefined_unionunionAsyncunknownunwrapurluuidvaluevariantvariantAsyncvoidvoid_BIC_REGEXCUID2_REGEXDECIMAL_REGEXEMAIL_REGEXEMOJI_REGEXHEX_COLOR_REGEXHEXADECIMAL_REGEXIMEI_REGEXIP_REGEXIPV4_REGEXIPV6_REGEXISO_DATE_REGEXISO_DATE_TIME_REGEXISO_TIME_REGEXISO_TIME_SECOND_REGEXISO_TIMESTAMP_REGEXISO_WEEK_REGEXMAC_REGEXMAC48_REGEXMAC64_REGEXOCTAL_REGEXULID_REGEXUUID_REGEX
index.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
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
T
T
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
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
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
v
v