pickAsync | /mod.ts | valibot@v0.25.0 | Deno

Skip to main content

x/valibot/mod.ts>pickAsync

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

fabian-hiller/valibot

Extremely Popular

Menu

mod.ts (default module)

ArraySchemaAsync

BaseSchemaAsync

BaseTransformation

BaseTransformationAsync

BaseValidationAsync

BigintSchemaAsync

BlobSchemaAsync

BooleanSchemaAsync

BytesValidation

CreditCardValidation

Cuid2Validation

CustomValidation

CustomValidationAsync

DateSchemaAsync

DecimalValidation

EmailValidation

EmojiValidation

EndsWithValidation

EnumSchemaAsync

EqualValidation

ExcludesValidation

FiniteValidation

HexadecimalValidation

HexColorValidation

IncludesValidation

InstanceSchemaAsync

IntegerValidation

IntersectOptions

IntersectSchema

InvalidActionResult

IsoDateTimeValidation

IsoDateValidation

IsoTimeSecondValidation

IsoTimestampValidation

IsoTimeValidation

IsoWeekValidation

LengthValidation

LiteralSchemaAsync

Mac48Validation

Mac64Validation

MaxBytesValidation

MaxLengthValidation

MaxSizeValidation

MaxValueValidation

MimeTypeValidation

MinBytesValidation

MinLengthValidation

MinSizeValidation

MinValueValidation

MultipleOfValidation

NeverSchemaAsync

NonNullableSchema

NonNullableSchemaAsync

NonNullishSchema

NonNullishSchemaAsync

NonOptionalSchema

NonOptionalSchemaAsync

NotBytesValidation

NotLengthValidation

NotSizeValidation

NotValueValidation

NullableSchemaAsync

NullishSchemaAsync

NullSchemaAsync

NumberSchemaAsync

ObjectEntriesAsync

ObjectSchemaAsync

OctalValidation

OptionalSchemaAsync

PartialObjectEntries

PartialObjectEntriesAsync

PicklistOptions

PicklistSchemaAsync

PipeActionResult

RecordSchemaAsync

RecursiveSchema

RecursiveSchemaAsync

RegexValidation

SafeIntegerValidation

SafeParseResult

SchemaWithBrand

SchemaWithFallback

SchemaWithFallbackAsync

SchemaWithMaybeDefault

SchemaWithMaybeDefaultAsync

SchemaWithMaybeFallback

SchemaWithMaybeFallbackAsync

SchemaWithTransform

SchemaWithTransformAsync

SpecialSchemaAsync

StartsWithValidation

StringSchemaAsync

SymbolSchemaAsync

ToCustomTransformation

ToCustomTransformationAsync

ToLowerCaseTransformation

ToMaxValueTransformation

ToMinValueTransformation

ToTrimmedEndTransformation

ToTrimmedStartTransformation

ToTrimmedTransformation

ToUpperCaseTransformation

TupleItemsAsync

TupleSchemaAsync

TypedSchemaResult

UndefinedSchema

UndefinedSchemaAsync

UnionOptionsAsync

UnionSchemaAsync

UnknownPathItem

UnknownSchemaAsync

UntypedSchemaResult

ValidActionResult

ValueValidation

VariantOptionAsync

VariantOptionsAsync

VariantSchemaAsync

VoidSchemaAsync

discriminatedUnion

discriminatedUnionAsync

HEX_COLOR_REGEX

HEXADECIMAL_REGEX

ISO_DATE_TIME_REGEX

ISO_TIME_SECOND_REGEX

ISO_TIMESTAMP_REGEX

nativeEnumAsync

undefinedTypeAsync

getDefaultAsync

getDefaultsAsync

getFallbackAsync

getFallbacksAsync

nonNullableAsync

nonNullishAsync

nonOptionalAsync

passthroughAsync

pipeResultAsync

restAndDefaultArgs

function pickAsync

import { pickAsync } from "https://deno.land/x/valibot@v0.25.0/mod.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.