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

x/valibot/src/methods/index.ts>SchemaWithRequired

The modular and type safe schema library for validating structural data 🤖
Extremely Popular
Latest
type alias SchemaWithRequired
import { type SchemaWithRequired } from "https://deno.land/x/valibot@v1.0.0-beta.2-to-json-schema/src/methods/index.ts";

Schema with required type.

Type Parameters

TSchema extends Schema
TKeys extends ObjectKeys<TSchema> | undefined
TMessage extends ErrorMessage<NonOptionalIssue> | undefined
definition: TSchema extends ObjectSchema<infer TEntries, ErrorMessage<ObjectIssue> | undefined> | StrictObjectSchema<infer TEntries, ErrorMessage<StrictObjectIssue> | undefined> ? Omit<TSchema, "entries" | "~types" | "~validate"> & { readonly entries: RequiredEntries<TEntries, TKeys, TMessage>; readonly ~types?: { readonly input: InferObjectInput<RequiredEntries<TEntries, TKeys, TMessage>>; readonly output: InferObjectOutput<RequiredEntries<TEntries, TKeys, TMessage>>; readonly issue: NonOptionalIssue | InferIssue<TSchema>; } | undefined; readonly ~validate: (dataset: UnknownDataset, config?: Config<BaseIssue<unknown>>) => OutputDataset<InferObjectOutput<RequiredEntries<TEntries, TKeys, TMessage>>, NonOptionalIssue | InferIssue<TSchema>>; } : TSchema extends LooseObjectSchema<infer TEntries, ErrorMessage<LooseObjectIssue> | undefined> ? Omit<TSchema, "entries" | "~types" | "~validate"> & { readonly entries: RequiredEntries<TEntries, TKeys, TMessage>; readonly ~types?: { readonly input: InferObjectInput<RequiredEntries<TEntries, TKeys, TMessage>> & { [key: string]: unknown; }; readonly output: InferObjectOutput<RequiredEntries<TEntries, TKeys, TMessage>> & { [key: string]: unknown; }; readonly issue: NonOptionalIssue | InferIssue<TSchema>; } | undefined; readonly ~validate: (dataset: UnknownDataset, config?: Config<BaseIssue<unknown>>) => OutputDataset<InferObjectOutput<RequiredEntries<TEntries, TKeys, TMessage>> & { [key: string]: unknown; }, NonOptionalIssue | InferIssue<TSchema>>; } : TSchema extends ObjectWithRestSchema<infer TEntries, infer TRest, ErrorMessage<ObjectWithRestIssue> | undefined> ? Omit<TSchema, "entries" | "~types" | "~validate"> & { readonly entries: RequiredEntries<TEntries, TKeys, TMessage>; readonly ~types?: { readonly input: InferObjectInput<RequiredEntries<TEntries, TKeys, TMessage>> & { [key: string]: InferInput<TRest>; }; readonly output: InferObjectOutput<RequiredEntries<TEntries, TKeys, TMessage>> & { [key: string]: InferOutput<TRest>; }; readonly issue: NonOptionalIssue | InferIssue<TSchema>; } | undefined; readonly ~validate: (dataset: UnknownDataset, config?: Config<BaseIssue<unknown>>) => OutputDataset<InferObjectOutput<RequiredEntries<TEntries, TKeys, TMessage>> & { [key: string]: InferOutput<TRest>; }, NonOptionalIssue | InferIssue<TSchema>>; } : never