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

Module

x/valibot/mod.ts>required

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

fabian-hiller/valibot

Extremely Popular

Go to Latest

src

mod.ts (default module)

NativeEnumSchemaAsync

NonNullableSchemaAsync

NonNullish

NonNullishSchema

NonNullishSchemaAsync

NonOptional

NonOptionalSchema

NonOptionalSchemaAsync

any

map

nan

set

url

function required

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

required<TObjectSchema extends ObjectSchema<any>>(schema: TObjectSchema, pipe?: Pipe<ObjectOutput<Required<TObjectSchema["object"]>>>): ObjectSchema<Required<TObjectSchema["object"]>>

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

required<TObjectSchema extends ObjectSchema<any>>(

schema: TObjectSchema,

error?: string,

pipe?: Pipe<ObjectOutput<Required<TObjectSchema["object"]>>>,

): ObjectSchema<Required<TObjectSchema["object"]>>

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

Type Parameters

TObjectSchema extends ObjectSchema<any>

Parameters

schema: TObjectSchema

The affected scheme.

optional

pipe: Pipe<ObjectOutput<Required<TObjectSchema["object"]>>>

A validation and transformation pipe.

Returns

ObjectSchema<Required<TObjectSchema["object"]>>

An object schema.

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

Type Parameters

TObjectSchema extends ObjectSchema<any>

Parameters

schema: TObjectSchema

The affected scheme.

optional

error: string

The error message.

optional

pipe: Pipe<ObjectOutput<Required<TObjectSchema["object"]>>>

A validation and transformation pipe.

Returns

ObjectSchema<Required<TObjectSchema["object"]>>

An object schema.