required | /src/methods/index.ts | valibot@v0.24.0

function required

import { required } from "https://deno.land/x/valibot@v0.24.0/src/methods/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 none 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 none 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 none 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 none 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 none 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 none 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 none 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.