/src/index.ts | valibot@v1.0.0-beta.5

Module

x/valibot/src/index.ts

The modular and type safe schema library for validating structural data 🤖

fabian-hiller/valibot

Popular

Latest

actions methods schemas storages types utils vitest

index.ts (default module)

BaseTransformationAsync

CheckItemsActionAsync

GenericTransformation

GenericTransformationAsync

GenericValidation

GenericValidationAsync

LooseObjectSchemaAsync

LooseTupleIssue

LooseTupleSchema

LooseTupleSchemaAsync

NonNullableSchemaAsync

NonNullishIssue

NonNullishSchema

NonNullishSchemaAsync

NonOptionalIssue

NonOptionalSchema

NonOptionalSchemaAsync

ObjectWithRestSchemaAsync

PartialCheckActionAsync

RawTransformActionAsync

StandardFailureResult

StandardSchemaProps

StandardSuccessResult

StrictObjectSchemaAsync

StrictTupleIssue

StrictTupleSchema

StrictTupleSchemaAsync

TupleWithRestSchemaAsync

UlidAction

UlidIssue

UndefinedableSchema

UndefinedableSchemaAsync

VariantOptionSchemaAsync

ArrayRequirementAsync

InferNonNullableInput

InferNonNullableIssue

InferNonNullableOutput

InferNonNullishInput

InferNonNullishIssue

InferNonNullishOutput

InferNonOptionalInput

InferNonOptionalIssue

InferNonOptionalOutput

InferUndefinedableOutput

InferVariantIssue

IntersectOptions

IntersectOptionsAsync

SchemaWithFallbackAsync

SchemaWithOmit

SchemaWithoutPipe

SchemaWithPartial

SchemaWithPartialAsync

SchemaWithRequiredAsync

ISO_TIME_SECOND_REGEX

any

bic

deleteSpecificMessage

mac

map

nan

set

url

ISO_TIME_SECOND_REGEX

import * as valibot from "https://deno.land/x/valibot@v1.0.0-beta.5/src/index.ts";

Classes

ValiError

A Valibot error with useful information.

Variables

v BASE64_REGEX	Base64 regex.
v BIC_REGEX	BIC regex.
v BrandSymbol	Brand symbol.
v CUID2_REGEX	Cuid2 regex.
v DECIMAL_REGEX	Decimal regex.
v DIGITS_REGEX	Digits regex.
v EMAIL_REGEX	Email regex.
v EMOJI_REGEX	Emoji regex from emoji-regex-xs v1.0.0 (MIT license).
v HEX_COLOR_REGEX	Hex color regex.
v HEXADECIMAL_REGEX	Hexadecimal regex.
v IMEI_REGEX	IMEI regex.
v IP_REGEX	IP regex.
v IPV4_REGEX	IPv4 regex.
v IPV6_REGEX	IPv6 regex.
v ISO_DATE_REGEX	ISO 8601 date regex.
v ISO_DATE_TIME_REGEX	ISO 8601 date-time regex.
v ISO_TIME_REGEX	ISO 8601 time regex.
v ISO_TIME_SECOND_REGEX	ISO 8601 time with seconds regex.
v ISO_TIMESTAMP_REGEX	ISO 8601 timestamp regex.
v ISO_WEEK_REGEX	ISO 8601 week regex.
v MAC_REGEX	MAC regex.
v MAC48_REGEX	MAC 48 bit regex.
v MAC64_REGEX	MAC 64 bit regex.
v NANO_ID_REGEX	Nano ID regex.
v OCTAL_REGEX	Octal regex.
v ULID_REGEX	ULID regex.
v UUID_REGEX	UUID regex.

Functions

f _addIssue	Adds an issue to the dataset.
f _getByteCount	Returns the byte count of the input.
f _getGraphemeCount	Returns the grapheme count of the input.
f _getStandardProps	Returns the Standard Schema properties.
f _getWordCount	Returns the word count of the input.
f _isLuhnAlgo	Checks whether a string with numbers corresponds to the luhn algorithm.
f _isValidObjectKey	Disallows inherited object properties and prevents object prototype pollution by disallowing certain keys.
f _joinExpects	Joins multiple `expects` values with the given separator.
f _stringify	Stringifies an unknown input to a literal or type string.
f any	Creates an any schema.
f args	Creates a function arguments transformation action.
f argsAsync	Creates a function arguments transformation action.
f array	Creates an array schema.
f arrayAsync	Creates an array schema.
f assert	Checks if the input matches the schema. As this is an assertion function, it can be used as a type guard.
f awaitAsync	Creates an await transformation action.
f base64	Creates a Base64 validation action.
f bic	Creates a BIC validation action.
f bigint	Creates a bigint schema.
f blob	Creates a blob schema.
f boolean	Creates a boolean schema.
f brand	Creates a brand transformation action.
f bytes	Creates a bytes validation action.
f check	Creates a check validation action.
f checkAsync	Creates a check validation action.
f checkItems	Creates an check items validation action.
f checkItemsAsync	Creates a check items validation action.
f config	Changes the local configuration of a schema.
f creditCard	Creates a credit card validation action.
f cuid2	Creates a Cuid2 validation action.
f custom	Creates a custom schema.
f customAsync	Creates a custom schema.
f date	Creates a date schema.
f decimal	Creates a decimal validation action.
f deleteGlobalConfig	Deletes the global configuration.
f deleteGlobalMessage	Deletes a global error message.
f deleteSchemaMessage	Deletes a schema error message.
f deleteSpecificMessage	Deletes a specific error message.
f description	Creates a description metadata action.
f digits	Creates a digits validation action.
f email	Creates an email validation action.
f emoji	Creates an emoji validation action.
f empty	Creates an empty validation action.
f endsWith	Creates an ends with validation action.
f entriesFromList	Creates an object entries definition from a list of keys and a schema.
f enum
f enum_	Creates an enum schema.
f everyItem	Creates an every item validation action.
f excludes	Creates an excludes validation action.
f fallback	Returns a fallback value as output if the input does not match the schema.
f fallbackAsync	Returns a fallback value as output if the input does not match the schema.
f file	Creates a file schema.
f filterItems	Creates a filter items transformation action.
f findItem	Creates a find item transformation action.
f finite	Creates a finite validation action.
f flatten	Flatten the error messages of issues.
f forward	Forwards the issues of the passed validation action.
f forwardAsync	Forwards the issues of the passed validation action.
f function
f function_	Creates a function schema.
f getDefault	Returns the default value of the schema.
f getDefaults	Returns the default values of the schema.
f getDefaultsAsync	Returns the default values of the schema.
f getDotPath	Creates and returns the dot path of an issue if possible.
f getFallback	Returns the fallback value of the schema.
f getFallbacks	Returns the fallback values of the schema.
f getFallbacksAsync	Returns the fallback values of the schema.
f getGlobalConfig	Returns the global configuration.
f getGlobalMessage	Returns a global error message.
f getSchemaMessage	Returns a schema error message.
f getSpecificMessage	Returns a specific error message.
f graphemes	Creates a graphemes validation action.
f hash	Creates a hash validation action.
f hexadecimal	Creates a hexadecimal validation action.
f hexColor	Creates a hex color validation action.
f imei	Creates an IMEI validation action.
f includes	Creates an includes validation action.
f instance	Creates an instance schema.
f integer	Creates an integer validation action.
f intersect	Creates an intersect schema.
f intersectAsync	Creates an intersect schema.
f ip	Creates an IP address validation action.
f ipv4	Creates an IPv4 address validation action.
f ipv6	Creates an IPv6 address validation action.
f is	Checks if the input matches the schema. By using a type predicate, this function can be used as a type guard.
f isoDate	Creates an ISO date validation action.
f isoDateTime	Creates an ISO date time validation action.
f isOfKind	A generic type guard to check the kind of an object.
f isOfType	A generic type guard to check the type of an object.
f isoTime	Creates an ISO time validation action.
f isoTimeSecond	Creates an ISO time second validation action.
f isoTimestamp	Creates an ISO timestamp validation action.
f isoWeek	Creates an ISO week validation action.
f isValiError	A type guard to check if an error is a ValiError.
f keyof	Creates a picklist schema of object keys.
f lazy	Creates a lazy schema.
f lazyAsync	Creates a lazy schema.
f length	Creates a length validation action.
f literal	Creates a literal schema.
f looseObject	Creates a loose object schema.
f looseObjectAsync	Creates a loose object schema.
f looseTuple	Creates a loose tuple schema.
f looseTupleAsync	Creates a loose tuple schema.
f mac	Creates a MAC address validation action.
f mac48	Creates a 48-bit MAC address validation action.
f mac64	Creates a 64-bit MAC address validation action.
f map	Creates a map schema.
f mapAsync	Creates a map schema.
f mapItems	Creates a map items transformation action.
f maxBytes	Creates a max bytes validation action.
f maxGraphemes	Creates a max graphemes validation action.
f maxLength	Creates a max length validation action.
f maxSize	Creates a max size validation action.
f maxValue	Creates a max value validation action.
f maxWords	Creates a max words validation action.
f metadata	Creates a custom metadata action.
f mimeType	Creates a MIME type validation action.
f minBytes	Creates a min bytes validation action.
f minGraphemes	Creates a min graphemes validation action.
f minLength	Creates a min length validation action.
f minSize	Creates a min size validation action.
f minValue	Creates a min value validation action.
f minWords	Creates a min words validation action.
f multipleOf	Creates a multiple of validation action.
f nan	Creates a NaN schema.
f nanoid	Creates a Nano ID validation action.
f never	Creates a never schema.
f nonEmpty	Creates a non-empty validation action.
f nonNullable	Creates a non nullable schema.
f nonNullableAsync	Creates a non nullable schema.
f nonNullish	Creates a non nullish schema.
f nonNullishAsync	Creates a non nullish schema.
f nonOptional	Creates a non optional schema.
f nonOptionalAsync	Creates a non optional schema.
f normalize	Creates a normalize transformation action.
f notBytes	Creates a not bytes validation action.
f notGraphemes	Creates a not graphemes validation action.
f notLength	Creates a not length validation action.
f notSize	Creates a not size validation action.
f notValue	Creates a not value validation action.
f notWords	Creates a not words validation action.
f null
f null_	Creates a null schema.
f nullable	Creates a nullable schema.
f nullableAsync	Creates a nullable schema.
f nullish	Creates a nullish schema.
f nullishAsync	Creates a nullish schema.
f number	Creates a number schema.
f object	Creates an object schema.
f objectAsync	Creates an object schema.
f objectWithRest	Creates an object with rest schema.
f objectWithRestAsync	Creates an object with rest schema.
f octal	Creates an octal validation action.
f omit	Creates a modified copy of an object schema that does not contain the selected entries.
f optional	Creates a optional schema.
f optionalAsync	Creates an optional schema.
f parse	Parses an unknown input based on a schema.
f parseAsync	Parses an unknown input based on a schema.
f parser	Returns a function that parses an unknown input based on a schema.
f parserAsync	Returns a function that parses an unknown input based on a schema.
f partial	Creates a modified copy of an object schema that marks all entries as optional.
f partialAsync	Creates a modified copy of an object schema that marks all entries as optional.
f partialCheck	Creates a partial check validation action.
f partialCheckAsync	Creates a partial check validation action.
f pick	Creates a modified copy of an object schema that contains only the selected entries.
f picklist	Creates a picklist schema.
f pipe	Adds a pipeline to a schema, that can validate and transform its input.
f pipeAsync	Adds a pipeline to a schema, that can validate and transform its input.
f promise	Creates a promise schema.
f rawCheck	Creates a raw check validation action.
f rawCheckAsync	Creates a raw check validation action.
f rawTransform	Creates a raw transformation action.
f rawTransformAsync	Creates a raw transformation action.
f readonly	Creates a readonly transformation action.
f record	Creates a record schema.
f recordAsync	Creates a record schema.
f reduceItems	Creates a reduce items transformation action.
f regex	Creates a regex validation action.
f required	Creates a modified copy of an object schema that marks all entries as required.
f requiredAsync	Creates a modified copy of an object schema that marks all entries as required.
f returns	Creates a function return transformation action.
f returnsAsync	Creates a function arguments transformation action.
f safeInteger	Creates a safe integer validation action.
f safeParse	Parses an unknown input based on a schema.
f safeParseAsync	Parses an unknown input based on a schema.
f safeParser	Returns a function that parses an unknown input based on a schema.
f safeParserAsync	Returns a function that parses an unknown input based on a schema.
f set	Creates a set schema.
f setAsync	Creates a set schema.
f setGlobalConfig	Sets the global configuration.
f setGlobalMessage	Sets a global error message.
f setSchemaMessage	Sets a schema error message.
f setSpecificMessage	Sets a specific error message.
f size	Creates a size validation action.
f someItem	Creates a some item validation action.
f sortItems	Creates a sort items transformation action.
f startsWith	Creates a starts with validation action.
f strictObject	Creates a strict object schema.
f strictObjectAsync	Creates a strict object schema.
f strictTuple	Creates a strict tuple schema.
f strictTupleAsync	Creates a strict tuple schema.
f string	Creates a string schema.
f symbol	Creates a symbol schema.
f title	Creates a title metadata action.
f toLowerCase	Creates a to lower case transformation action.
f toMaxValue	Creates a to max value transformation action.
f toMinValue	Creates a to min value transformation action.
f toUpperCase	Creates a to upper case transformation action.
f transform	Creates a custom transformation action.
f transformAsync	Creates a custom transformation action.
f trim	Creates a trim transformation action.
f trimEnd	Creates a trim end transformation action.
f trimStart	Creates a trim start transformation action.
f tuple	Creates a tuple schema.
f tupleAsync	Creates a tuple schema.
f tupleWithRest	Creates a tuple with rest schema.
f tupleWithRestAsync	Creates a tuple with rest schema.
f ulid	Creates an ULID validation action.
f undefined
f undefined_	Creates an undefined schema.
f undefinedable	Creates a undefinedable schema.
f undefinedableAsync	Creates an undefinedable schema.
f union	Creates an union schema.
f unionAsync	Creates an union schema.
f unknown	Creates a unknown schema.
f unwrap	Unwraps the wrapped schema.
f url	Creates an URL validation action.
f uuid	Creates an UUID validation action.
f value	Creates a value validation action.
f variant	Creates a variant schema.
f variantAsync	Creates a variant schema.
f void
f void_	Creates a void schema.
f words	Creates a words validation action.

Interfaces

I AnySchema	Any schema type.
I ArgsAction	Args action type.
I ArgsActionAsync	Args action async type.
I ArrayIssue	Array issue type.
I ArrayPathItem	Array path item type.
I ArraySchema	Array schema type.
I ArraySchemaAsync	Array schema type.
I AwaitActionAsync	Await action async type.
I Base64Action	Base64 action type.
I Base64Issue	Base64 issue type.
I BaseIssue	Base issue type.
I BaseMetadata	Base metadata type.
I BaseSchema	Base schema type.
I BaseSchemaAsync	Base schema async type.
I BaseTransformation	Base transformation type.
I BaseTransformationAsync	Base transformation async type.
I BaseValidation	Base validation type.
I BaseValidationAsync	Base validation async type.
I BicAction	BIC action type.
I BicIssue	BIC issue type.
I BigintIssue	Bigint issue type.
I BigintSchema	Bigint schema type.
I BlobIssue	Blob issue type.
I BlobSchema	Blob schema type.
I BooleanIssue	Boolean issue type.
I BooleanSchema	Boolean schema type.
I Brand	Brand type.
I BrandAction	Brand action type.
I BytesAction	Bytes action type.
I BytesIssue	Bytes issue type.
I CheckAction	Check action type.
I CheckActionAsync	Check action async type.
I CheckIssue	Check issue type.
I CheckItemsAction	Check items action type.
I CheckItemsActionAsync	Check items action async type.
I CheckItemsIssue	Check items issue type.
I Config	Config type.
I CreditCardAction	Credit card action type.
I CreditCardIssue	Credit card issue type.
I Cuid2Action	Cuid2 action type.
I Cuid2Issue	Cuid2 issue type.
I CustomIssue	Custom issue type.
I CustomSchema	Custom schema type.
I CustomSchemaAsync	Custom schema async type.
I DateIssue	Date issue type.
I DateSchema	Date schema type.
I DecimalAction	Decimal action type.
I DecimalIssue	Decimal issue type.
I DescriptionAction	Description action type.
I DigitsAction	Digits action type.
I DigitsIssue	Digits issue type.
I EmailAction	Email action type.
I EmailIssue	Email issue type.
I EmojiAction	Emoji action type.
I EmojiIssue	Emoji issue type.
I EmptyAction	Empty action type.
I EmptyIssue	Empty issue type.
I EndsWithAction	Ends with action type.
I EndsWithIssue	Ends with issue type.
I Enum	Enum type.
I EnumIssue	Enum issue type.
I EnumSchema	Enum schema type.
I EveryItemAction	Every item action type.
I EveryItemIssue	Every item issue type.
I ExcludesAction	Excludes action type.
I ExcludesIssue	Excludes issue type.
I FailureDataset	Failure dataset type.
I FileIssue	File issue type.
I FileSchema	File schema type.
I FilterItemsAction	Filter items action type.
I FindItemAction	Find item action type.
I FiniteAction	Finite action type.
I FiniteIssue	Finite issue type.
I FunctionIssue	Function issue type.
I FunctionSchema	Function schema type.
I GenericIssue	Generic issue type.
I GenericMetadata	Generic metadata type.
I GenericSchema	Generic schema type.
I GenericSchemaAsync	Generic schema async type.
I GenericTransformation	Generic transformation type.
I GenericTransformationAsync	Generic transformation async type.
I GenericValidation	Generic validation type.
I GenericValidationAsync	Generic validation async type.
I GraphemesAction	Graphemes action type.
I GraphemesIssue	Graphemes issue type.
I HashAction	Hash action type.
I HashIssue	Hash issue type.
I HexadecimalAction	Hexadecimal action type.
I HexadecimalIssue	Hexadecimal issue type.
I HexColorAction	Hex color action type.
I HexColorIssue	Hex color issue type.
I ImeiAction	IMEI action type.
I ImeiIssue	IMEI issue type.
I IncludesAction	Includes action type.
I IncludesIssue	Includes issue type.
I InstanceIssue	Instance issue type.
I InstanceSchema	Instance schema type.
I IntegerAction	Integer action type.
I IntegerIssue	Integer issue type.
I IntersectIssue	Intersect issue type.
I IntersectSchema	Intersect schema type.
I IntersectSchemaAsync	Intersect schema async type.
I IpAction	IP action type.
I IpIssue	IP issue type.
I Ipv4Action	IPv4 action type.
I Ipv4Issue	IPv4 issue type.
I Ipv6Action	IPv6 action type.
I Ipv6Issue	IPv6 issue type.
I IsoDateAction	ISO date action type.
I IsoDateIssue	ISO date issue type.
I IsoDateTimeAction	ISO date time action type.
I IsoDateTimeIssue	ISO date time issue type.
I IsoTimeAction	ISO time action type.
I IsoTimeIssue	ISO time issue type.
I IsoTimeSecondAction	ISO time second action type.
I IsoTimeSecondIssue	ISO time second issue type.
I IsoTimestampAction	ISO timestamp action type.
I IsoTimestampIssue	ISO timestamp issue type.
I IsoWeekAction	ISO week action type.
I IsoWeekIssue	ISO week issue type.
I LazySchema	Lazy schema type.
I LazySchemaAsync	Lazy schema async type.
I LengthAction	Length action type.
I LengthIssue	Length issue type.
I LiteralIssue	Literal issue type.
I LiteralSchema	Literal schema type.
I LooseObjectIssue	Loose object issue type.
I LooseObjectSchema	Loose object schema type.
I LooseObjectSchemaAsync	Object schema async type.
I LooseTupleIssue	Loose tuple issue type.
I LooseTupleSchema	Loose tuple schema type.
I LooseTupleSchemaAsync	Loose tuple schema async type.
I Mac48Action	48-bit MAC action type.
I Mac48Issue	48-bit MAC issue type.
I Mac64Action	64-bit MAC action type.
I Mac64Issue	64-bit MAC issue type.
I MacAction	MAC action type.
I MacIssue	MAC issue type.
I MapIssue	Map issue type.
I MapItemsAction	Map items action type.
I MapPathItem	Map path item type.
I MapSchema	Map schema type.
I MapSchemaAsync	Map schema async type.
I MaxBytesAction	Max bytes action type.
I MaxBytesIssue	Max bytes issue type.
I MaxGraphemesAction	Max graphemes action type.
I MaxGraphemesIssue	Max graphemes issue type.
I MaxLengthAction	Max length action type.
I MaxLengthIssue	Max length issue type.
I MaxSizeAction	Max size action type.
I MaxSizeIssue	Max size issue type.
I MaxValueAction	Max value action type.
I MaxValueIssue	Max value issue type.
I MaxWordsAction	Max words action type.
I MaxWordsIssue	Max words issue type.
I MetadataAction	Metadata action type.
I MimeTypeAction	MIME type action type.
I MimeTypeIssue	MIME type issue type.
I MinBytesAction	Min bytes action type.
I MinBytesIssue	Min bytes issue type.
I MinGraphemesAction	Min graphemes action type.
I MinGraphemesIssue	Min graphemes issue type.
I MinLengthAction	Min length action type.
I MinLengthIssue	Min length issue type.
I MinSizeAction	Min size action type.
I MinSizeIssue	Min size issue type.
I MinValueAction	Min value action type.
I MinValueIssue	Min value issue type.
I MinWordsAction	Min words action type.
I MinWordsIssue	Min words issue type.
I MultipleOfAction	Multiple of action type.
I MultipleOfIssue	Multiple of issue type.
I NanIssue	NaN issue type.
I NanoIDAction	Nano ID action type.
I NanoIDIssue	Nano ID issue type.
I NanSchema	NaN schema type.
I NeverIssue	Never issue type.
I NeverSchema	Never schema type.
I NonEmptyAction	Non empty action type.
I NonEmptyIssue	Non empty issue type.
I NonNullableIssue	Non nullable issue type.
I NonNullableSchema	Non nullable schema type.
I NonNullableSchemaAsync	Non nullable schema async type.
I NonNullishIssue	Non nullish issue type.
I NonNullishSchema	Non nullish schema type.
I NonNullishSchemaAsync	Non nullish schema async type.
I NonOptionalIssue	Non optional issue type.
I NonOptionalSchema	Non optional schema type.
I NonOptionalSchemaAsync	Non optional schema async type.
I NormalizeAction	Normalize action type.
I NotBytesAction	Not bytes action type.
I NotBytesIssue	Not bytes issue type.
I NotGraphemesAction	Not graphemes action type.
I NotGraphemesIssue	Not graphemes issue type.
I NotLengthAction	Not length action type.
I NotLengthIssue	Not length issue type.
I NotSizeAction	Not size action type.
I NotSizeIssue	Not size issue type.
I NotValueAction	Not value action type.
I NotValueIssue	Not value issue type.
I NotWordsAction	Not words action type.
I NotWordsIssue	Not words issue type.
I NullableSchema	Nullable schema type.
I NullableSchemaAsync	Nullable schema async type.
I NullishSchema	Nullish schema type.
I NullishSchemaAsync	Nullish schema async type.
I NullIssue	Null issue type.
I NullSchema	Null schema type.
I NumberIssue	Number issue type.
I NumberSchema	Number schema type.
I ObjectEntries	Object entries type.
I ObjectEntriesAsync	Object entries async type.
I ObjectIssue	Object issue type.
I ObjectPathItem	Object path item type.
I ObjectSchema	Object schema type.
I ObjectSchemaAsync	Object schema async type.
I ObjectWithRestIssue	Object with rest issue type.
I ObjectWithRestSchema	Object with rest schema type.
I ObjectWithRestSchemaAsync	Object schema async type.
I OctalAction	Octal action type.
I OctalIssue	Octal issue type.
I OptionalSchema	Optional schema type.
I OptionalSchemaAsync	Optional schema async type.
I Parser	The parser type.
I ParserAsync	The parser async type.
I PartialCheckAction	Partial check action type.
I PartialCheckActionAsync	Partial check action async type.
I PartialCheckIssue	Partial check issue type.
I PartialDataset	Partial dataset type.
I PicklistIssue	Picklist issue type.
I PicklistSchema	Picklist schema type.
I PromiseIssue	Promise issue type.
I PromiseSchema	Promise schema type.
I RawCheckAction	Raw check action type.
I RawCheckActionAsync	Raw check action async type.
I RawCheckIssue	Raw check issue type.
I RawTransformAction	Raw transform action type.
I RawTransformActionAsync	Raw transform action async type.
I RawTransformIssue	Raw transform issue type.
I ReadonlyAction	Readonly action type.
I RecordIssue	Record issue type.
I RecordSchema	Record schema type.
I RecordSchemaAsync	Record schema async type.
I ReduceItemsAction	Reduce items action type.
I RegexAction	Regex action type.
I RegexIssue	Regex issue type.
I ReturnsAction	Returns action type.
I ReturnsActionAsync	Returns action async type.
I SafeIntegerAction	Safe integer action type.
I SafeIntegerIssue	Safe integer issue type.
I SafeParser	The safe parser type.
I SafeParserAsync	The safe parser async type.
I SetIssue	Set issue type.
I SetPathItem	Set path item type.
I SetSchema	Set schema type.
I SetSchemaAsync	Set schema async type.
I SizeAction	Size action type.
I SizeIssue	Size issue type.
I SomeItemAction	Some item action type.
I SomeItemIssue	Some item issue type.
I SortItemsAction	Sort items action type.
I StandardFailureResult	The result interface if validation fails.
I StandardSchemaProps	The Standard Schema properties interface.
I StandardSuccessResult	The result interface if validation succeeds.
I StartsWithAction	Starts with action type.
I StartsWithIssue	Starts with issue type.
I StrictObjectIssue	Strict object issue type.
I StrictObjectSchema	Strict object schema type.
I StrictObjectSchemaAsync	Strict object schema async type.
I StrictTupleIssue	Strict tuple issue type.
I StrictTupleSchema	Strict tuple schema type.
I StrictTupleSchemaAsync	Strict tuple schema async type.
I StringIssue	String issue type.
I StringSchema	String schema type.
I SuccessDataset	Success dataset type.
I SymbolIssue	Symbol issue type.
I SymbolSchema	Symbol schema type.
I TitleAction	Title action type.
I ToLowerCaseAction	To lower case action type.
I ToMaxValueAction	To max value action type.
I ToMinValueAction	To min value action type.
I ToUpperCaseAction	To upper case action type.
I TransformAction	Transform action type.
I TransformActionAsync	Transform action async type.
I TrimAction	Trim action type.
I TrimEndAction	Trim end action type.
I TrimStartAction	Trim start action type.
I TupleIssue	Tuple issue type.
I TupleSchema	Tuple schema type.
I TupleSchemaAsync	Tuple schema async type.
I TupleWithRestIssue	Tuple with rest issue type.
I TupleWithRestSchema	Tuple with rest schema type.
I TupleWithRestSchemaAsync	Tuple with rest schema async type.
I UlidAction	ULID action type.
I UlidIssue	ULID issue type.
I UndefinedableSchema	Undefinedable schema type.
I UndefinedableSchemaAsync	Undefinedable schema async type.
I UndefinedIssue	Undefined issue type.
I UndefinedSchema	Undefined schema type.
I UnionIssue	Union issue type.
I UnionSchema	Union schema type.
I UnionSchemaAsync	Union schema async type.
I UnknownDataset	Unknown dataset type.
I UnknownPathItem	Unknown path item type.
I UnknownSchema	Unknown schema type.
I UrlAction	URL action type.
I UrlIssue	URL issue type.
I UuidAction	UUID action type.
I UuidIssue	UUID issue type.
I ValueAction	Value action type.
I ValueIssue	Value issue type.
I VariantIssue	Variant issue type.
I VariantOptionSchema	Variant option schema type.
I VariantOptionSchemaAsync	Variant option schema async type.
I VariantSchema	Variant schema type.
I VariantSchemaAsync	Variant schema async type.
I VoidIssue	Void issue type.
I VoidSchema	Void schema type.
I WordsAction	Words action type.
I WordsIssue	Words issue type.

Type Aliases

T ArrayInput	Array input type.
T ArrayRequirement	Array requirement type.
T ArrayRequirementAsync	Array requirement async type.
T BrandName	Brand name type.
T Class	Class type.
T ContentInput	Content input type.
T ContentRequirement	Content requirement type.
T DeepPickN	Deeply picks N specific keys.
T Default	Default type.
T DefaultAsync	Default async type.
T DefaultValue	Default value type.
T ErrorMessage	Error message type.
T Fallback	Fallback type.
T FallbackAsync	Fallback async type.
T FirstTupleItem	Extracts first tuple item.
T FlatErrors	Flat errors type.
T GlobalConfig	The global config type.
T HashType	Hash type type.
T InferDefault	Infer default type.
T InferDefaults	Infer defaults type.
T InferFallback	Infer fallback type.
T InferFallbacks	Infer fallbacks type.
T InferInput	Infer input type.
T InferIntersectInput	Infer intersect input type.
T InferIntersectOutput	Infer intersect output type.
T InferIssue	Infer issue type.
T InferMapInput	Infer map input type.
T InferMapOutput	Infer map output type.
T InferNonNullableInput	Infer non nullable input type.
T InferNonNullableIssue	Infer non nullable issue type.
T InferNonNullableOutput	Infer non nullable output type.
T InferNonNullishInput	Infer non nullish input type.
T InferNonNullishIssue	Infer non nullish issue type.
T InferNonNullishOutput	Infer non nullish output type.
T InferNonOptionalInput	Infer non optional input type.
T InferNonOptionalIssue	Infer non optional issue type.
T InferNonOptionalOutput	Infer non optional output type.
T InferNullableOutput	Infer nullable output type.
T InferNullishOutput	Infer nullish output type.
T InferObjectInput	Infer object input type.
T InferObjectIssue	Infer object issue type.
T InferObjectOutput	Infer object output type.
T InferOptionalOutput	Infer optional output type.
T InferOutput	Infer output type.
T InferRecordInput	Infer record input type.
T InferRecordOutput	Infer record output type.
T InferSetInput	Infer set input type.
T InferSetOutput	Infer set output type.
T InferTupleInput	Infer tuple input type.
T InferTupleIssue	Infer tuple issue type.
T InferTupleOutput	Infer tuple output type.
T InferUndefinedableOutput	Infer undefinedable output type.
T InferVariantIssue	Infer variant issue type.
T IntersectOptions	Intersect options type.
T IntersectOptionsAsync	Intersect options async type.
T IssueDotPath	Issue dot path type.
T IssuePathItem	Issue path item type.
T LastTupleItem	Extracts last tuple item.
T LengthInput	Length input type.
T Literal	Literal type.
T MarkOptional	Marks specific keys as optional.
T MaybePromise	Constructs a type that is maybe a promise.
T MaybeReadonly	Constructs a type that is maybe readonly.
T NonNullable	Extracts `null` from a type.
T NonNullish	Extracts `null` and `undefined` from a type.
T NonOptional	Extracts `undefined` from a type.
T NormalizeForm	Normalize form type.
T ObjectKeys	Object keys type.
T OutputDataset	Output dataset type.
T PathKeys	Extracts tuples with path keys.
T PicklistOptions	Picklist options type.
T PipeAction	Pipe action type.
T PipeActionAsync	Pipe action async type.
T PipeItem	Pipe item type.
T PipeItemAsync	Pipe item async type.
T Prettify	Prettifies a type for better readability.
T SafeParseResult	Safe parse result type.
T SchemaWithFallback	Schema with fallback type.
T SchemaWithFallbackAsync	Schema with fallback async type.
T SchemaWithOmit	Schema with omit type.
T SchemaWithoutPipe	Schema without pipe type.
T SchemaWithPartial	Schema with partial type.
T SchemaWithPartialAsync	Schema with partial type.
T SchemaWithPick	Schema with pick type.
T SchemaWithPipe	Schema with pipe type.
T SchemaWithPipeAsync	Schema with pipe async type.
T SchemaWithRequired	Schema with required type.
T SchemaWithRequiredAsync	Schema with required type.
T SizeInput	Size input type.
T StandardResult	The result interface of the validate function.
T TupleItems	Tuple items type.
T TupleItemsAsync	Tuple items async type.
T UnionOptions	Union options type.
T UnionOptionsAsync	Union options async type.
T UnionToIntersect	Converts union to intersection type.
T UnionToTuple	Converts union to tuple type.
T ValueInput	Value input type.
T VariantOptions	Variant options type.
T VariantOptionsAsync	Variant options async type.