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

Module

x/valibot/src/index.ts>required

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

fabian-hiller/valibot

Go to Latest

error methods schemas transformations utils validations

index.ts (default module)

IntersectionOptionsAsync

IntersectionSchema

IntersectionSchemaAsync

NativeEnumSchemaAsync

NonNullableSchemaAsync

NonNullish

NonNullishSchema

NonNullishSchemaAsync

NonOptional

NonOptionalSchema

NonOptionalSchemaAsync

any

map

nan

set

url

function required

import { required } from "https://deno.land/x/valibot@v0.19.0/src/index.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?: ErrorMessage,

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 schema.

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 schema.

optional

error: ErrorMessage

The error message.

optional

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

A validation and transformation pipe.

Returns

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

An object schema.