Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/valibot/src/types/schema.ts>BaseSchema

The modular and type safe schema library for validating structural data 🤖
fabian-hiller/valibot
Latest
interface BaseSchema
import { type BaseSchema } from "https://deno.land/x/valibot@v1.0.0-beta.5/src/types/schema.ts";

Base schema type.

Type Parameters

TInput
TOutput
TIssue extends BaseIssue<unknown>

Properties

readonly
kind: "schema"

The object kind.

readonly
type: string

The schema type.

readonly
reference: (...args: any[]) => BaseSchema<unknown, unknown, BaseIssue<unknown>>

The schema reference.

readonly
expects: string

The expected property.

readonly
async: false

Whether it's async.

readonly
~standard: StandardSchemaProps<TInput, TOutput>

The Standard Schema properties.

readonly
~run: (dataset: UnknownDataset, config: Config<BaseIssue<unknown>>) => OutputDataset<TOutput, TIssue>

Parses unknown input values.

readonly
optional
~types: { readonly input: TInput; readonly output: TOutput; readonly issue: TIssue; } | undefined

The input, output and issue type.