required | /src/index.ts | valibot@v0.30.0

Module

x/valibot/src/index.ts>required

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

fabian-hiller/valibot

Extremely Popular

Go to Latest

error methods schemas storages transformations types utils validations

index.ts (default module)

BaseTransformationAsync

CustomValidationAsync

HexadecimalValidation

IsoDateTimeValidation

IsoDateValidation

IsoTimeSecondValidation

IsoTimestampValidation

NonNullableSchemaAsync

NonNullishSchema

NonNullishSchemaAsync

NonOptionalSchema

NonOptionalSchemaAsync

SafeIntegerValidation

ToCustomTransformation

ToCustomTransformationAsync

ToLowerCaseTransformation

ToMaxValueTransformation

ToMinValueTransformation

ToTrimmedEndTransformation

ToTrimmedStartTransformation

ToTrimmedTransformation

ToUpperCaseTransformation

IntersectOptionsAsync

PartialObjectEntriesAsync

SchemaWithFallbackAsync

SchemaWithMaybeDefault

SchemaWithMaybeDefaultAsync

SchemaWithMaybeFallback

SchemaWithMaybeFallbackAsync

SchemaWithTransform

SchemaWithTransformAsync

ISO_TIME_SECOND_REGEX

any

bic

deleteSpecificMessage

mac

map

nan

set

url

ISO_TIME_SECOND_REGEX

function required

import { required } from "https://deno.land/x/valibot@v0.30.0/src/index.ts";

required<TSchema extends ObjectSchema<any, any>>(schema: TSchema, pipe?: Pipe<ObjectOutput<Required<TSchema["entries"]>, undefined>>): ObjectSchema<Required<TSchema["entries"]>>

Creates an object schema consisting of all properties of an existing object schema set to non optional.

required<TSchema extends ObjectSchema<any, any>>(

schema: TSchema,

message?: ErrorMessage,

pipe?: Pipe<ObjectOutput<Required<TSchema["entries"]>, undefined>>,

): ObjectSchema<Required<TSchema["entries"]>>

Creates an object schema consisting of all properties of an existing object schema set to non optional.

required<TSchema extends ObjectSchema<any, any>, TRest extends BaseSchema | undefined>(

schema: TSchema,

rest: TRest,

pipe?: Pipe<ObjectOutput<Required<TSchema["entries"]>, TRest>>,

): ObjectSchema<Required<TSchema["entries"]>, TRest>

Creates an object schema consisting of all properties of an existing object schema set to non optional.

required<TSchema extends ObjectSchema<any, any>, TRest extends BaseSchema | undefined>(

schema: TSchema,

rest: TRest,

message?: ErrorMessage,

pipe?: Pipe<ObjectOutput<Required<TSchema["entries"]>, TRest>>,

): ObjectSchema<Required<TSchema["entries"]>, TRest>

Creates an object schema consisting of all properties of an existing object schema set to non optional.

Type Parameters

TSchema extends ObjectSchema<any, any>

Parameters

schema: TSchema

The affected schema.

optional

pipe: Pipe<ObjectOutput<Required<TSchema["entries"]>, undefined>>

A validation and transformation pipe.

Returns

ObjectSchema<Required<TSchema["entries"]>>

An object schema.

Creates an object schema consisting of all properties of an existing object schema set to non optional.

Type Parameters

TSchema extends ObjectSchema<any, any>

Parameters

schema: TSchema

The affected schema.

optional

message: ErrorMessage

The error message.

optional

pipe: Pipe<ObjectOutput<Required<TSchema["entries"]>, undefined>>

A validation and transformation pipe.

Returns

ObjectSchema<Required<TSchema["entries"]>>

An object schema.

Creates an object schema consisting of all properties of an existing object schema set to non optional.

Type Parameters

TSchema extends ObjectSchema<any, any>

TRest extends BaseSchema | undefined

Parameters

schema: TSchema

The affected schema.

rest: TRest

The object rest.

optional

pipe: Pipe<ObjectOutput<Required<TSchema["entries"]>, TRest>>

A validation and transformation pipe.

Returns

ObjectSchema<Required<TSchema["entries"]>, TRest>

An object schema.

Creates an object schema consisting of all properties of an existing object schema set to non optional.

Type Parameters

TSchema extends ObjectSchema<any, any>

TRest extends BaseSchema | undefined

Parameters

schema: TSchema

The affected schema.

rest: TRest

The object rest.

optional

message: ErrorMessage

The error message.

optional

pipe: Pipe<ObjectOutput<Required<TSchema["entries"]>, TRest>>

A validation and transformation pipe.

Returns

ObjectSchema<Required<TSchema["entries"]>, TRest>

An object schema.