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

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

Functions

f assert	Checks if the input matches the schema. As this is an assertion function, it can be used as a type guard.
f config	Changes the local configuration of a schema.
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 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 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 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 is	Checks if the input matches the schema. By using a type predicate, this function can be used as a type guard.
f keyof	Creates a picklist schema of object keys.
f omit	Creates a modified copy of an object schema that does not contain the selected entries.
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 pick	Creates a modified copy of an object schema that contains only the selected entries.
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 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 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 unwrap	Unwraps the wrapped schema.

Interfaces

I Parser	The parser type.
I ParserAsync	The parser async type.
I SafeParser	The safe parser type.
I SafeParserAsync	The safe parser async type.

Type Aliases

T Fallback	Fallback type.
T FallbackAsync	Fallback async type.
T FlatErrors	Flat errors type.
T InferDefault	Infer default type.
T InferDefaults	Infer defaults type.
T InferFallback	Infer fallback type.
T InferFallbacks	Infer fallbacks type.
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 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.