pickAsync | /src/methods/index.ts | valibot@v0.24.0 | Deno

Skip to main content

Deno 2 is finally here 🎉️

x/valibot/src/methods/index.ts>pickAsync

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

fabian-hiller/valibot

Menu

brand coerce fallback forward getDefault getDefaults getFallback getFallbacks is keyof merge omit parse partial passthrough pick required safeParse strict strip transform unwrap withDefault

index.ts (default module)

PartialObjectEntries

PartialObjectEntriesAsync

SafeParseResult

SchemaWithBrand

SchemaWithFallback

SchemaWithFallbackAsync

SchemaWithMaybeDefault

SchemaWithMaybeDefaultAsync

SchemaWithMaybeFallback

SchemaWithMaybeFallbackAsync

SchemaWithTransform

SchemaWithTransformAsync

getDefaultAsync

getDefaultsAsync

getFallbackAsync

getFallbacksAsync

passthroughAsync

function pickAsync

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

pickAsync<TSchema extends ObjectSchema<any, any> | ObjectSchemaAsync<any, any>, TKeys extends (keyof TSchema["entries"])[]>(

schema: TSchema,

keys: TKeys,

pipe?: PipeAsync<ObjectOutput<Pick<TSchema["entries"], TKeys[number]>, undefined>>,

): ObjectSchemaAsync<Pick<TSchema["entries"], TKeys[number]>>

Creates an async object schema that contains only the selected keys of an existing schema.

pickAsync<TSchema extends ObjectSchema<any, any> | ObjectSchemaAsync<any, any>, TKeys extends (keyof TSchema["entries"])[]>(

schema: TSchema,

keys: TKeys,

message?: ErrorMessage,

pipe?: PipeAsync<ObjectOutput<Pick<TSchema["entries"], TKeys[number]>, undefined>>,

): ObjectSchemaAsync<Pick<TSchema["entries"], TKeys[number]>>

Creates an async object schema that contains only the selected keys of an existing schema.

pickAsync<TSchema extends ObjectSchema<any, any> | ObjectSchemaAsync<any, any>, TKeys extends (keyof TSchema["entries"])[], TRest extends BaseSchema | BaseSchemaAsync | undefined>(

schema: TSchema,

keys: TKeys,

rest: TRest,

pipe?: PipeAsync<ObjectOutput<Pick<TSchema["entries"], TKeys[number]>, TRest>>,

): ObjectSchemaAsync<Pick<TSchema["entries"], TKeys[number]>, TRest>

Creates an async object schema that contains only the selected keys of an existing schema.

pickAsync<TSchema extends ObjectSchema<any, any> | ObjectSchemaAsync<any, any>, TKeys extends (keyof TSchema["entries"])[], TRest extends BaseSchema | BaseSchemaAsync | undefined>(

schema: TSchema,

keys: TKeys,

rest: TRest,

message?: ErrorMessage,

pipe?: PipeAsync<ObjectOutput<Pick<TSchema["entries"], TKeys[number]>, TRest>>,

): ObjectSchemaAsync<Pick<TSchema["entries"], TKeys[number]>, TRest>

Creates an async object schema that contains only the selected keys of an existing schema.

Creates an async object schema that contains only the selected keys of an existing schema.

Type Parameters

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

TKeys extends (keyof TSchema["entries"])[]

Parameters

schema: TSchema

The schema to pick from.

keys: TKeys

The selected keys

optional

pipe: PipeAsync<ObjectOutput<Pick<TSchema["entries"], TKeys[number]>, undefined>>

A validation and transformation pipe.

Returns

ObjectSchemaAsync<Pick<TSchema["entries"], TKeys[number]>>

An async object schema.

Creates an async object schema that contains only the selected keys of an existing schema.

Type Parameters

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

TKeys extends (keyof TSchema["entries"])[]

Parameters

schema: TSchema

The schema to pick from.

keys: TKeys

The selected keys

optional

message: ErrorMessage

The error message.

optional

pipe: PipeAsync<ObjectOutput<Pick<TSchema["entries"], TKeys[number]>, undefined>>

A validation and transformation pipe.

Returns

ObjectSchemaAsync<Pick<TSchema["entries"], TKeys[number]>>

An async object schema.

Creates an async object schema that contains only the selected keys of an existing schema.

Type Parameters

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

TKeys extends (keyof TSchema["entries"])[]

TRest extends BaseSchema | BaseSchemaAsync | undefined

Parameters

schema: TSchema

The schema to pick from.

keys: TKeys

The selected keys

rest: TRest

The object rest.

optional

pipe: PipeAsync<ObjectOutput<Pick<TSchema["entries"], TKeys[number]>, TRest>>

A validation and transformation pipe.

Returns

ObjectSchemaAsync<Pick<TSchema["entries"], TKeys[number]>, TRest>

An async object schema.

Creates an async object schema that contains only the selected keys of an existing schema.

Type Parameters

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

TKeys extends (keyof TSchema["entries"])[]

TRest extends BaseSchema | BaseSchemaAsync | undefined

Parameters

schema: TSchema

The schema to pick from.

keys: TKeys

The selected keys

rest: TRest

The object rest.

optional

message: ErrorMessage

The error message.

optional

pipe: PipeAsync<ObjectOutput<Pick<TSchema["entries"], TKeys[number]>, TRest>>

A validation and transformation pipe.

Returns

ObjectSchemaAsync<Pick<TSchema["entries"], TKeys[number]>, TRest>

An async object schema.