required | /mod.ts | valibot@v0.35.0

Module

x/valibot/mod.ts>required

The modular and type safe schema library for validating structural data 🤖

fabian-hiller/valibot

Extremely Popular

Latest

src

mod.ts (default module)

BaseTransformationAsync

GenericTransformation

GenericTransformationAsync

GenericValidation

GenericValidationAsync

LooseObjectSchemaAsync

LooseTupleIssue

LooseTupleSchema

LooseTupleSchemaAsync

NonNullableSchemaAsync

NonNullishIssue

NonNullishSchema

NonNullishSchemaAsync

NonOptionalIssue

NonOptionalSchema

NonOptionalSchemaAsync

ObjectWithRestSchemaAsync

PartialCheckActionAsync

RawTransformActionAsync

StrictObjectSchemaAsync

StrictTupleIssue

StrictTupleSchema

StrictTupleSchemaAsync

TupleWithRestSchemaAsync

InferNonNullableInput

InferNonNullableIssue

InferNonNullableOutput

InferNonNullishInput

InferNonNullishIssue

InferNonNullishOutput

InferNonOptionalInput

InferNonOptionalIssue

InferNonOptionalOutput

IntersectOptionsAsync

QuestionMarkSchemaAsync

SafeParseResult

SchemaWithFallback

SchemaWithFallbackAsync

SchemaWithOmit

SchemaWithPartial

SchemaWithPartialAsync

SchemaWithRequiredAsync

ISO_TIME_SECOND_REGEX

any

bic

deleteSpecificMessage

mac

map

nan

set

url

function required

import { required } from "https://deno.land/x/valibot@v0.35.0/mod.ts";

required<TSchema extends Schema>(schema: TSchema): SchemaWithRequired<TSchema, undefined, undefined>

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

required<TSchema extends Schema, TMessage extends ErrorMessage<NonOptionalIssue> | undefined>(schema: TSchema, message: TMessage): SchemaWithRequired<TSchema, undefined, TMessage>

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

required<TSchema extends Schema, TKeys extends ObjectKeys<TSchema>>(schema: TSchema, keys: TKeys): SchemaWithRequired<TSchema, TKeys, undefined>

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

required<TSchema extends Schema, TKeys extends ObjectKeys<TSchema>, TMessage extends ErrorMessage<NonOptionalIssue> | undefined>(

schema: TSchema,

keys: TKeys,

message: TMessage,

): SchemaWithRequired<TSchema, TKeys, TMessage>

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

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

Type Parameters

TSchema extends Schema

Parameters

schema: TSchema

The schema to modify.

Returns

SchemaWithRequired<TSchema, undefined, undefined>

An object schema.

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

Type Parameters

TSchema extends Schema

TMessage extends ErrorMessage<NonOptionalIssue> | undefined

Parameters

schema: TSchema

The schema to modify.

message: TMessage

The error message.

Returns

SchemaWithRequired<TSchema, undefined, TMessage>

An object schema.

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

Type Parameters

TSchema extends Schema

TKeys extends ObjectKeys<TSchema>

Parameters

schema: TSchema

The schema to modify.

keys: TKeys

The selected entries.

Returns

SchemaWithRequired<TSchema, TKeys, undefined>

An object schema.

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

Type Parameters

TSchema extends Schema

TKeys extends ObjectKeys<TSchema>

TMessage extends ErrorMessage<NonOptionalIssue> | undefined

Parameters

schema: TSchema

The schema to modify.

keys: TKeys

The selected entries.

message: TMessage

The error message.

Returns

SchemaWithRequired<TSchema, TKeys, TMessage>

An object schema.