@valibot/valibot@1.1.0

Built and signed on GitHub Actions

Built and signed on GitHub Actions

Returns the Standard Schema properties.

Creates an any schema.

Any schema interface.

Creates a function arguments transformation action.

Args action type.

Args action async type.

Creates a function arguments transformation action.

Creates an array schema.

Creates an array schema.

Array input type.

Array issue interface.

Array path item interface.

Array requirement type.

Array requirement async type.

Array schema interface.

Array schema interface.

Checks if the input matches the schema. As this is an assertion function, it can be used as a type guard.

Await action async interface.

Creates an await transformation action.

Creates a Base64 validation action.

Base64 regex.

Base64 action interface.

Base64 issue interface.

Base issue interface.

Base metadata interface.

Base schema interface.

Base schema async interface.

Base transformation interface.

Base transformation async interface.

Base validation interface.

Base validation async interface.

Creates a BIC validation action.

BIC regex.

BIC action interface.

BIC issue interface.

Creates a bigint schema.

Bigint issue interface.

Bigint schema interface.

Creates a blob schema.

Blob issue interface.

Blob schema interface.

Creates a boolean schema.

Boolean issue interface.

Boolean schema interface.

Brand interface.

Creates a brand transformation action.

Brand action interface.

Brand name type.

Brand symbol.

Creates a bytes validation action.

Bytes action interface.

Bytes issue interface.

Creates a check validation action.

Check action interface.

Check action async interface.

Creates a check validation action.

Check issue interface.

Creates an check items validation action.

Check items action interface.

Check items action async interface.

Creates a check items validation action.

Check items issue interface.

Class type.

Config interface.

Changes the local configuration of a schema.

Content input type.

Content requirement type.

Creates a credit card validation action.

Credit card action interface.

Credit card issue interface.

Creates a Cuid2 validation action.

Cuid2 regex.

Cuid2 action interface.

Cuid2 issue interface.

Creates a custom schema.

Creates a custom schema.

Custom issue interface.

Custom schema interface.

Custom schema async interface.

Creates a date schema.

Date issue interface.

Date schema interface.

Creates a decimal validation action.

Decimal regex.

Decimal action interface.

Decimal issue interface.

Default type.

Default async type.

Default value type.

Deletes the global configuration.

Deletes a global error message.

Deletes a schema error message.

Deletes a specific error message.

Creates a description metadata action.

Description action interface.

Creates a digits validation action.

Digits regex.

Digits action interface.

Digits issue interface.

Creates an email validation action.

Email address regex.

Email action interface.

Email issue interface.

Creates an emoji validation action.

Emoji regex from emoji-regex-xs v1.0.0 (MIT license).

Emoji action interface.

Emoji issue interface.

Creates an empty validation action.

Empty action interface.

Empty issue interface.

Creates an ends with validation action.

Ends with action interface.

Ends with issue interface.

Creates an entries validation action.

Entries action interface.

Creates an object entries definition from a list of keys and a schema.

Creates a new object entries definition from existing object schemas.

Entries input type.

Entries issue interface.

Enum interface.

Creates an enum schema.

Creates an enum schema.

Enum issue interface.

Enum schema interface.

Enum values type.

Error message type.

Creates an every item validation action.

Every item action interface.

Every item issue interface.

Creates an exact optional schema.

Creates an exact optional schema.

Exact optional schema interface.

Exact optional schema async interface.

Creates an excludes validation action.

Excludes action interface.

Excludes issue interface.

Failure dataset interface.

Fallback type.

Returns a fallback value as output if the input does not match the schema.

Fallback async type.

Returns a fallback value as output if the input does not match the schema.

Creates a file schema.

File issue interface.

File schema interface.

Creates a filter items transformation action.

Filter items action interface.

Creates a find item transformation action.

Find item action interface.

Creates a finite validation action.

Finite action interface.

Finite issue interface.

Flat errors type.

Flatten the error messages of issues.

Flavor interface.

Creates a flavor transformation action.

Flavor action interface.

Flavor name type.

Flavor symbol.

Forwards the issues of the passed validation action.

Forwards the issues of the passed validation action.

Creates a function schema.

Creates a function schema.

Function issue interface.

Function schema interface.

Generic issue type.

Generic metadata type.

Generic pipe action type.

Generic pipe action async type.

Generic pipe item type.

Generic pipe item async type.

Generic schema type.

Generic schema async type.

Generic transformation type.

Generic transformation async type.

Generic validation type.

Generic validation async type.

Returns the default value of the schema.

Returns the default values of the schema.

Returns the default values of the schema.

Returns the description of the schema.

Creates and returns the dot path of an issue if possible.

Returns the fallback value of the schema.

Returns the fallback values of the schema.

Returns the fallback values of the schema.

Returns the global configuration.

Returns a global error message.

Returns the metadata of a schema.

Returns a schema error message.

Returns a specific error message.

Returns the title of the schema.

The global config type.

Creates a graphemes validation action.

Graphemes action interface.

Graphemes issue interface.

Creates a greater than value validation action.

Greater than value action type.

Greater than value issue type.

Creates a hash validation action.

Hash action interface.

Hash issue interface.

Hash type type.

Hex color regex.

Creates a hexadecimal validation action.

Hexadecimal regex.

Hexadecimal action interface.

Hexadecimal issue interface.

Creates a hex color validation action.

Hex color action interface.

Hex color issue interface.

Creates an IMEI validation action.

IMEI regex.

IMEI action interface.

IMEI issue interface.

Creates an includes validation action.

Includes action interface.

Includes issue interface.

Infer default type.

Infer defaults type.

Infer fallback type.

Infer fallbacks type.

Infer input type.

Infer issue type.

Infer metadata type.

Infer output type.

Creates an instance schema.

Instance issue interface.

Instance schema interface.

Creates an integer validation action.

Integer action interface.

Integer issue interface.

Creates an intersect schema.

Creates an intersect schema.

Intersect issue interface.

Intersect options type.

Intersect options async type.

Intersect schema interface.

Intersect schema async interface.

Creates an IP address validation action.

IP regex.

IP action interface.

IP issue interface.

Creates an IPv4 address validation action.

IPv4 regex.

IPv4 action interface.

IPv4 issue interface.

Creates an IPv6 address validation action.

IPv6 regex.

IPv6 action interface.

IPv6 issue interface.

Checks if the input matches the schema. By using a type predicate, this function can be used as a type guard.

ISO 8601 date regex.

ISO 8601 date-time regex.

ISO 8601 time regex.

ISO 8601 time with seconds regex.

ISO 8601 timestamp regex.

ISO 8601 week regex.

Creates an ISO date validation action.

ISO date action interface.

ISO date issue interface.

Creates an ISO date time validation action.

ISO date time action interface.

ISO date time issue interface.

A generic type guard to check the kind of an object.

A generic type guard to check the type of an object.

Creates an ISO time validation action.

ISO time action interface.

ISO time issue interface.

Creates an ISO time second validation action.

ISO time second action interface.

ISO time second issue interface.

Creates an ISO timestamp validation action.

ISO timestamp action interface.

ISO timestamp issue interface.

Creates an ISO week validation action.

ISO week action interface.

ISO week issue interface.

Issue dot path type.

Issue path item type.

A type guard to check if an error is a ValiError.

Creates a picklist schema of object keys.

Creates a lazy schema.

Creates a lazy schema.

Lazy schema interface.

Lazy schema async interface.

Creates a length validation action.

Length action interface.

Length input type.

Length issue interface.

Literal type.

Creates a literal schema.

Literal issue interface.

Literal schema interface.

Creates a loose object schema.

Creates a loose object schema.

Loose object issue interface.

Loose object schema interface.

Object schema async interface.

Creates a loose tuple schema.

Creates a loose tuple schema.

Loose tuple issue interface.

Loose tuple schema interface.

Loose tuple schema async interface.

Creates a less than value validation action.

Less than value action type.

Less than value issue type.

Creates a MAC address validation action.

Creates a 48-bit MAC address validation action.

MAC 48 bit regex.

48-bit MAC action interface.

48-bit MAC issue interface.

Creates a 64-bit MAC address validation action.

MAC 64 bit regex.

64-bit MAC action interface.

64-bit MAC issue interface.

MAC regex.

MAC action interface.

MAC issue interface.

Creates a map schema.

Creates a map schema.

Map issue interface.

Creates a map items transformation action.

Map items action interface.

Map path item interface.

Map schema interface.

Map schema async interface.

Creates a max bytes validation action.

Max bytes action interface.

Max bytes issue interface.

Creates a max entries validation action.

Max entries action interface.

Max entries issue interface.

Creates a max graphemes validation action.

Max graphemes action interface.

Max graphemes issue interface.

Creates a max length validation action.

Max length action interface.

Max length issue interface.

Creates a max size validation action.

Max size action interface.

Max size issue interface.

Creates a max value validation action.

Max value action interface.

Max value issue interface.

Creates a max words validation action.

Max words action interface.

Max words issue interface.

Changes the local message configuration of a schema.

Creates a custom metadata action.

Metadata action interface.

Creates a MIME type validation action.

MIME type action interface.

MIME type issue interface.

Creates a min bytes validation action.

Min bytes action interface.

Min bytes issue interface.

Creates a min entries validation action.

Min entries action interface.

Min entries issue interface.

Creates a min graphemes validation action.

Min graphemes action interface.

Min graphemes issue interface.

Creates a min length validation action.

Min length action interface.

Min length issue interface.

Creates a min size validation action.

Min size action interface.

Min size issue interface.

Creates a min value validation action.

Min value action interface.

Min value issue interface.

Creates a min words validation action.

Min words action interface.

Min words issue interface.

Creates a multiple of validation action.

Multiple of action interface.

Multiple of issue interface.

Creates a NaN schema.

NaN issue interface.

Nano ID regex.

Creates a Nano ID validation action.

Nano ID action interface.

Nano ID issue interface.

NaN schema interface.

Creates a never schema.

Never issue interface.

Never schema interface.

Creates a non-empty validation action.

Non empty action interface.

Non empty issue interface.

Creates a non nullable schema.

Creates a non nullable schema.

Non nullable issue interface.

Non nullable schema interface.

Non nullable schema async interface.

Creates a non nullish schema.

Creates a non nullish schema.

Non nullish issue interface.

Non nullish schema interface.

Non nullish schema async interface.

Creates a non optional schema.

Creates a non optional schema.

Non optional issue interface.

Non optional schema interface.

Non optional schema async interface.

Creates a normalize transformation action.

Normalize action interface.

Normalize form type.

Creates a not bytes validation action.

Not bytes action interface.

Not bytes issue interface.

Creates a not entries validation action.

Not entries action interface.

Not entries issue interface.

Creates a not graphemes validation action.

Not graphemes action interface.

Not graphemes issue interface.

Creates a not length validation action.

Not length action interface.

Not length issue interface.

Creates a not size validation action.

Not size action interface.

Not size issue interface.

Creates a not value validation action.

Not value action interface.

Not value issue interface.

Creates a not values validation action.

Not values action type.

Not values issue type.

Creates a not words validation action.

Not words action interface.

Not words issue interface.

Creates a null schema.

Creates a null schema.

Creates a nullable schema.

Creates a nullable schema.

Nullable schema interface.

Nullable schema async interface.

Creates a nullish schema.

Creates a nullish schema.

Nullish schema interface.

Nullish schema async interface.

Null issue interface.

Null schema interface.

Creates a number schema.

Number issue interface.

Number schema interface.

Creates an object schema.

Creates an object schema.

Object entries interface.

Object entries async interface.

Object issue interface.

Object keys type.

Object path item interface.

Object schema interface.

Object schema async interface.

Creates an object with rest schema.

Creates an object with rest schema.

Object with rest issue interface.

Object with rest schema interface.

Object schema async interface.

Creates an octal validation action.

Octal regex.

Octal action interface.

Octal issue interface.

Creates a modified copy of an object schema that does not contain the selected entries.

Creates an optional schema.

Creates an optional schema.

Optional schema interface.

Optional schema async interface.

Output dataset type.

Parses an unknown input based on a schema.

Parses an unknown input based on a schema.

Creates a parse JSON transformation action.

Parse JSON action interface.

Parse JSON config interface.

Parse JSON issue interface.

The parser interface.

Returns a function that parses an unknown input based on a schema.

The parser async interface.

Returns a function that parses an unknown input based on a schema.

Creates a modified copy of an object schema that marks all entries as optional.

Creates a modified copy of an object schema that marks all entries as optional.

Creates a partial check validation action.

Partial check action interface.

Partial check action async interface.

Creates a partial check validation action.

Partial check issue interface.

Partial dataset interface.

Creates a modified copy of an object schema that contains only the selected entries.

Creates a picklist schema.

Picklist issue interface.

Picklist options type.

Picklist schema interface.

Adds a pipeline to a schema, that can validate and transform its input.

Pipe action type.

Pipe action async type.

Adds a pipeline to a schema, that can validate and transform its input.

Pipe item type.

Pipe item async type.

Creates a promise schema.

Promise issue interface.

Promise schema interface.

Creates a raw check validation action.

Raw check action interface.

Raw check action async interface.

Creates a raw check validation action.

Raw check issue interface.

Creates a raw transformation action.

Raw transform action interface.

Raw transform action async interface.

Creates a raw transformation action.

Raw transform issue interface.

Creates a readonly transformation action.

Readonly action interface.

Creates a record schema.

Creates a record schema.

Record issue interface.

Record schema interface.

Record schema async interface.

Creates a reduce items transformation action.

Reduce items action interface.

Creates a regex validation action.

Regex action interface.

Regex issue interface.

Creates a modified copy of an object schema that marks all entries as required.

Creates a modified copy of an object schema that marks all entries as required.

Creates a function return transformation action.

Returns action type.

Returns action async type.

Creates a function arguments transformation action.

RFC 5322 email address regex.

Creates a RFC email validation action.

RFC email action interface.

RFC email issue interface.

Creates a safe integer validation action.

Safe integer action interface.

Safe integer issue interface.

Parses an unknown input based on a schema.

Parses an unknown input based on a schema.

The safe parser interface.

Returns a function that parses an unknown input based on a schema.

The safe parser async interface.

Returns a function that parses an unknown input based on a schema.

Safe parse result type.

Schema with fallback type.

Schema with fallback async type.

Schema with omit type.

Schema without pipe type.

Schema with partial type.

Schema with partial type.

Schema with pick type.

Schema with pipe type.

Schema with pipe async type.

Schema with required type.

Schema with required type.

Creates a set schema.

Creates a set schema.

Sets the global configuration.

Sets a global error message.

Set issue interface.

Set path item interface.

Set schema interface.

Set schema async interface.

Sets a schema error message.

Sets a specific error message.

Creates a size validation action.

Size action interface.

Size input type.

Size issue interface.

Creates a slug validation action.

Slug regex.

Slug action type.

Slug issue type.

Creates a some item validation action.

Some item action interface.

Some item issue interface.

Creates a sort items transformation action.

Sort items action interface.

The Standard Schema properties interface.

Creates a starts with validation action.

Starts with action interface.

Starts with issue interface.

Creates a strict object schema.

Creates a strict object schema.

Strict object issue interface.

Strict object schema interface.

Strict object schema async interface.

Creates a strict tuple schema.

Creates a strict tuple schema.

Strict tuple issue interface.

Strict tuple schema interface.

Strict tuple schema async interface.

Creates a string schema.

Creates a stringify JSON transformation action.

Stringify JSON action interface.

Stringify JSON config interface.

Stringify JSON issue interface.

String issue interface.

String schema interface.

Success dataset interface.

Summarize the error messages of issues in a pretty-printable multi-line string.

Creates a symbol schema.

Symbol issue interface.

Symbol schema interface.

Creates a title metadata action.

Title action interface.

Creates a to lower case transformation action.

To lower case action interface.

Creates a to max value transformation action.

To max value action interface.

Creates a to min value transformation action.

To min value action interface.