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

function partialAsync

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

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

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

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

schema: TSchema,

message?: ErrorMessage,

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

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

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

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

schema: TSchema,

rest: TRest,

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

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

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

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

schema: TSchema,

rest: TRest,

message?: ErrorMessage,

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

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

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

Type Parameters

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

Parameters

schema: TSchema

The affected schema.

optional

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

A validation and transformation pipe.

Returns

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

An async object schema.

Creates an async object schema consisting of all properties of an existing object schema set to 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<PartialObjectEntriesAsync<TSchema["entries"]>, undefined>>

A validation and transformation pipe.

Returns

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

An async object schema.

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

Type Parameters

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

TRest extends BaseSchema | undefined

Parameters

schema: TSchema

The affected schema.

rest: TRest

The object rest.

optional

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

A validation and transformation pipe.

Returns

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

An async object schema.

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

Type Parameters

TSchema extends ObjectSchema<any, any> | ObjectSchemaAsync<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: PipeAsync<ObjectOutput<PartialObjectEntriesAsync<TSchema["entries"]>, TRest>>

A validation and transformation pipe.

Returns

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

An async object schema.