requiredAsync | /src/index.ts | valibot@v0.24.0

Module

x/valibot/src/index.ts>requiredAsync

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

fabian-hiller/valibot

Go to Latest

error methods schemas transformations types utils validations

index.ts (default module)

BaseTransformationAsync

CustomValidationAsync

IsoDateTimeValidation

IsoDateValidation

IsoTimeSecondValidation

IsoTimestampValidation

NonNullableSchemaAsync

NonNullish

NonNullishSchema

NonNullishSchemaAsync

NonOptional

NonOptionalSchema

NonOptionalSchemaAsync

PartialObjectEntriesAsync

SafeIntegerValidation

SchemaWithFallbackAsync

SchemaWithMaybeDefault

SchemaWithMaybeDefaultAsync

SchemaWithMaybeFallback

SchemaWithMaybeFallbackAsync

SchemaWithTransform

SchemaWithTransformAsync

ToCustomTransformation

ToCustomTransformationAsync

ToLowerCaseTransformation

ToMaxValueTransformation

ToMinValueTransformation

ToTrimmedEndTransformation

ToTrimmedStartTransformation

ToTrimmedTransformation

ToUpperCaseTransformation

discriminatedUnionAsync

ISO_TIME_SECOND_REGEX

any

bic

mac

map

nan

set

url

ISO_TIME_SECOND_REGEX

function requiredAsync

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

requiredAsync<TSchema extends ObjectSchema<any, any> | ObjectSchemaAsync<any, any>>(schema: TSchema, pipe?: PipeAsync<ObjectOutput<Required<TSchema["entries"]>, undefined>>): ObjectSchemaAsync<Required<TSchema["entries"]>>

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

requiredAsync<TSchema extends ObjectSchema<any, any> | ObjectSchemaAsync<any, any>>(

schema: TSchema,

message?: ErrorMessage,

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

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

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

requiredAsync<TSchema extends ObjectSchema<any, any> | ObjectSchemaAsync<any, any>, TRest extends BaseSchema | BaseSchemaAsync | undefined>(

schema: TSchema,

rest: TRest,

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

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

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

requiredAsync<TSchema extends ObjectSchema<any, any> | ObjectSchemaAsync<any, any>, TRest extends BaseSchema | BaseSchemaAsync | undefined>(

schema: TSchema,

rest: TRest,

message?: ErrorMessage,

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

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

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

Type Parameters

TSchema extends ObjectSchema<any, any> | ObjectSchemaAsync<any, any>

Parameters

schema: TSchema

The affected schema.

optional

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

A validation and transformation pipe.

Returns

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

An async object schema.

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

Type Parameters

TSchema extends ObjectSchema<any, any> | ObjectSchemaAsync<any, any>

Parameters

schema: TSchema

The affected schema.

optional

message: ErrorMessage

The error message.

optional

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

A validation and transformation pipe.

Returns

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

An async object schema.

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

Type Parameters

TSchema extends ObjectSchema<any, any> | ObjectSchemaAsync<any, any>

TRest extends BaseSchema | BaseSchemaAsync | undefined

Parameters

schema: TSchema

The affected schema.

rest: TRest

The object rest.

optional

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

A validation and transformation pipe.

Returns

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

An async object schema.

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

Type Parameters

TSchema extends ObjectSchema<any, any> | ObjectSchemaAsync<any, any>

TRest extends BaseSchema | BaseSchemaAsync | undefined

Parameters

schema: TSchema

The affected schema.

rest: TRest

The object rest.

optional

message: ErrorMessage

The error message.

optional

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

A validation and transformation pipe.

Returns

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

An async object schema.