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

function pick

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

pick<TSchema extends ObjectSchema<any, any>, TKeys extends (keyof TSchema["entries"])[]>(

schema: TSchema,

keys: TKeys,

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

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

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

pick<TSchema extends ObjectSchema<any, any>, TKeys extends (keyof TSchema["entries"])[]>(

schema: TSchema,

keys: TKeys,

message?: ErrorMessage,

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

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

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

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

schema: TSchema,

keys: TKeys,

rest: TRest,

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

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

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

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

schema: TSchema,

keys: TKeys,

rest: TRest,

message?: ErrorMessage,

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

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

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

Type Parameters

TSchema extends ObjectSchema<any, any>

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

Parameters

schema: TSchema

The schema to pick from.

keys: TKeys

The selected keys

optional

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

A validation and transformation pipe.

Returns

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

An object schema.

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

Type Parameters

TSchema extends ObjectSchema<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: Pipe<ObjectOutput<Pick<TSchema["entries"], TKeys[number]>, undefined>>

A validation and transformation pipe.

Returns

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

An object schema.

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

Type Parameters

TSchema extends ObjectSchema<any, any>

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

TRest extends BaseSchema | undefined

Parameters

schema: TSchema

The schema to pick from.

keys: TKeys

The selected keys

rest: TRest

The object rest.

optional

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

A validation and transformation pipe.

Returns

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

An object schema.

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

Type Parameters

TSchema extends ObjectSchema<any, any>

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

TRest extends BaseSchema | 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: Pipe<ObjectOutput<Pick<TSchema["entries"], TKeys[number]>, TRest>>

A validation and transformation pipe.

Returns

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

An object schema.