Skip to main content
Module

x/valibot/mod.ts>omit

The modular and type safe schema library for validating structural data 🤖
fabian-hiller/valibot
Extremely Popular
Go to Latest
function omit
import { omit } from "https://deno.land/x/valibot@v0.9.0/mod.ts";

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

Type Parameters

TObjectSchema extends ObjectSchema<any>
TKeys extends ObjectKeys<TObjectSchema>

Parameters

schema: TObjectSchema

The schema to omit from.

keys: TKeys

The selected keys

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

A validation and transformation pipe.

Returns

ObjectSchema<Omit<TObjectSchema["object"], TKeys[number]>>

An object schema.

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

Type Parameters

TObjectSchema extends ObjectSchema<any>
TKeys extends ObjectKeys<TObjectSchema>

Parameters

schema: TObjectSchema

The schema to omit from.

keys: TKeys

The selected keys

optional
error: string

The error message.

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

A validation and transformation pipe.

Returns

ObjectSchema<Omit<TObjectSchema["object"], TKeys[number]>>

An object schema.