pick | /src/methods/pick/index.ts | valibot@v0.5.0

function pick

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

pick<TObjectSchema extends ObjectSchema<any>, TKeys extends (keyof TObjectSchema["object"])[]>(

keys: TKeys,

pipe?: Pipe<ObjectOutput<Pick<TObjectSchema["object"], TKeys[number]>>>,

): ObjectSchema<Pick<TObjectSchema["object"], TKeys[number]>>

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

pick<TObjectSchema extends ObjectSchema<any>, TKeys extends (keyof TObjectSchema["object"])[]>(

keys: TKeys,

error?: string,

pipe?: Pipe<ObjectOutput<Pick<TObjectSchema["object"], TKeys[number]>>>,

): ObjectSchema<Pick<TObjectSchema["object"], TKeys[number]>>

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

Type Parameters

TObjectSchema extends ObjectSchema<any>

TKeys extends (keyof TObjectSchema["object"])[]

The schema to pick from.

keys: TKeys

The selected keys

optional

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

A validation and transformation pipe.

An object schema.

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

TObjectSchema extends ObjectSchema<any>

TKeys extends (keyof TObjectSchema["object"])[]

The schema to pick from.

keys: TKeys

The selected keys

optional

error: string

The error message.

optional

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

A validation and transformation pipe.

An object schema.