Skip to main content
Module

x/valibot/mod.ts>pickAsync

The modular and type safe schema library for validating structural data 🤖
fabian-hiller/valibot
Extremely Popular
Go to Latest
function pickAsync
import { pickAsync } from "https://deno.land/x/valibot@v0.6.0/mod.ts";

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

Type Parameters

TObjectSchema extends ObjectSchema<any> | ObjectSchemaAsync<any>
TKeys extends (keyof TObjectSchema["object"])[]

Parameters

schema: TObjectSchema

The schema to pick from.

keys: TKeys

The selected keys

optional
pipe: PipeAsync<ObjectOutput<Pick<TObjectSchema["object"], TKeys[number]>>>

A validation and transformation pipe.

Returns

ObjectSchemaAsync<Pick<TObjectSchema["object"], TKeys[number]>>

An async object schema.

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

Type Parameters

TObjectSchema extends ObjectSchema<any> | ObjectSchemaAsync<any>
TKeys extends (keyof TObjectSchema["object"])[]

Parameters

schema: TObjectSchema

The schema to pick from.

keys: TKeys

The selected keys

optional
error: string

The error message.

optional
pipe: PipeAsync<ObjectOutput<Pick<TObjectSchema["object"], TKeys[number]>>>

A validation and transformation pipe.

Returns

ObjectSchemaAsync<Pick<TObjectSchema["object"], TKeys[number]>>

An async object schema.