pickAsync | /src/index.ts | valibot@v0.30.0

Module

x/valibot/src/index.ts>pickAsync

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

fabian-hiller/valibot

Extremely Popular

Go to Latest

error methods schemas storages transformations types utils validations

index.ts (default module)

BaseTransformationAsync

CustomValidationAsync

HexadecimalValidation

IsoDateTimeValidation

IsoDateValidation

IsoTimeSecondValidation

IsoTimestampValidation

NonNullableSchemaAsync

NonNullishSchema

NonNullishSchemaAsync

NonOptionalSchema

NonOptionalSchemaAsync

SafeIntegerValidation

ToCustomTransformation

ToCustomTransformationAsync

ToLowerCaseTransformation

ToMaxValueTransformation

ToMinValueTransformation

ToTrimmedEndTransformation

ToTrimmedStartTransformation

ToTrimmedTransformation

ToUpperCaseTransformation

IntersectOptionsAsync

PartialObjectEntriesAsync

SchemaWithFallbackAsync

SchemaWithMaybeDefault

SchemaWithMaybeDefaultAsync

SchemaWithMaybeFallback

SchemaWithMaybeFallbackAsync

SchemaWithTransform

SchemaWithTransformAsync

ISO_TIME_SECOND_REGEX

any

bic

deleteSpecificMessage

mac

map

nan

set

url

ISO_TIME_SECOND_REGEX

function pickAsync

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

pickAsync<TSchema extends ObjectSchema<any, any> | ObjectSchemaAsync<any, any>, TKeys extends ObjectKeys<TSchema>>(

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 ObjectKeys<TSchema>>(

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 ObjectKeys<TSchema>, 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 ObjectKeys<TSchema>, 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.

Type Parameters

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

TKeys extends ObjectKeys<TSchema>

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 ObjectKeys<TSchema>

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 ObjectKeys<TSchema>

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 ObjectKeys<TSchema>

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.