picklist | /src/schemas/index.ts | valibot@v0.24.0

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

any array bigint blob boolean date enum instance intersect literal map nan never nonNullable nonNullish nonOptional null nullable nullish number object optional picklist record recursive set special string symbol tuple undefined union unknown variant void

index.ts (default module)

AnySchema

NonNullableSchemaAsync

NonNullish

NonNullishSchema

NonNullishSchemaAsync

NonOptional

NonOptionalSchema

NonOptionalSchemaAsync

discriminatedUnionAsync

any

map

nan

set

function picklist

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

picklist<TOption extends string, TOptions extends PicklistOptions<TOption>>(options: TOptions, message?: ErrorMessage): PicklistSchema<TOptions>

Creates a picklist schema.

Type Parameters

TOption extends string

TOptions extends PicklistOptions<TOption>

Parameters

options: TOptions

The picklist value.

optional

message: ErrorMessage = [UNSUPPORTED]

The error message.

Returns

PicklistSchema<TOptions>

A picklist schema.