/src/methods/index.ts | valibot@v0.24.0

import * as valibot from "https://deno.land/x/valibot@v0.24.0/src/methods/index.ts";

Variables

v BrandSymbol	Brand symbol.
v useDefault deprecated	See withDefault

Functions

f brand	Brands the output type of a schema.
f coerce	Coerces the input of a schema to match the required type.
f coerceAsync	Coerces the input of a async schema to match the required type.
f fallback	Returns a fallback value when validating the passed schema failed.
f fallbackAsync	Returns a fallback value when validating the passed schema failed.
f forward	Forwards the issues of the passed validation.
f getDefault	Returns the default value of the schema.
f getDefaultAsync	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 getFallback	Returns the fallback value of the schema.
f getFallbackAsync	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 is	Checks if the input matches the scheme. By using a type predicate, this function can be used as a type guard.
f keyof	Creates a enum schema of object keys.
f merge	Merges the entries of multiple object schemas. Subsequent object entries overwrite the previous ones.
f mergeAsync	Merges the entries of multiple async object schemas. Subsequent object entries overwrite the previous ones.
f omit	Creates an object schema that contains not the selected keys of an existing schema.
f omitAsync	Creates an async object schema that contains only the selected keys of an existing schema.
f parse	Parses unknown input based on a schema.
f parseAsync	Parses unknown input based on a schema.
f partial	Creates an object schema consisting of all properties of an existing object schema set to optional.
f partialAsync	Creates an async object schema consisting of all properties of an existing object schema set to optional.
f passthrough deprecated	Creates an object schema that passes unknown keys.
f passthroughAsync deprecated	Creates an object schema that passes unknown keys.
f pick	Creates an object schema that contains only the selected keys of an existing schema.
f pickAsync	Creates an async object schema that contains only the selected keys of an existing schema.
f required	Creates an object schema consisting of all properties of an existing object schema set to none optional.
f requiredAsync	Creates an async object schema consisting of all properties of an existing object schema set to none optional.
f safeParse	Parses unknown input based on a schema.
f safeParseAsync	Parses unknown input based on a schema.
f strict deprecated	Creates a strict object schema that throws an error if an input contains unknown keys.
f strictAsync deprecated	Creates a strict async object schema that throws an error if an input contains unknown keys.
f strip deprecated	Creates an object schema that strips unknown keys.
f stripAsync deprecated	Creates an object schema that strips unknown keys.
f transform	Adds a transformation step to a schema, which is executed at the end of parsing and can change the output type.
f transformAsync	Adds an async transformation step to a schema, which is executed at the end of parsing and can change the output type.
f unwrap	Unwraps the wrapped schema.
f withDefault deprecated	Passes a default value to a schema in case of an undefined input.

Type Aliases

T Brand	Brand type.
T BrandName	Brand name type.
T DefaultValue	Default value type.
T DefaultValues	Default values type.
T FallbackInfo	Fallback info type.
T FallbackValue	Fallback value type.
T FallbackValues	Fallback values type.
T PartialObjectEntries	Partial object entries type.
T PartialObjectEntriesAsync	Partial object entries async type.
T SafeParseResult	Safe parse result type.
T SchemaWithBrand	Schema with brand type.
T SchemaWithFallback	Schema with fallback type.
T SchemaWithFallbackAsync	Schema with fallback async type.
T SchemaWithMaybeDefault	Schema with maybe default type.
T SchemaWithMaybeDefaultAsync	Schema with maybe default async type.
T SchemaWithMaybeFallback	Schema with maybe fallback type.
T SchemaWithMaybeFallbackAsync	Schema with maybe fallback async type.
T SchemaWithTransform	Schema with transform type.
T SchemaWithTransformAsync	Schema with transform async type.