omit | /src/index.ts | valibot@v0.8.0

Module

x/valibot/src/index.ts>omit

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

fabian-hiller/valibot

Go to Latest

error methods schemas transformations utils validations

index.ts (default module)

NativeEnumSchemaAsync

NonNullableSchemaAsync

NonNullish

NonNullishSchema

NonNullishSchemaAsync

NonOptional

NonOptionalSchema

NonOptionalSchemaAsync

any

map

nan

set

url

function omit

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

omit<TObjectSchema extends ObjectSchema<any>, TKeys extends ObjectKeys<TObjectSchema>>(

schema: TObjectSchema,

keys: TKeys,

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

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

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

omit<TObjectSchema extends ObjectSchema<any>, TKeys extends ObjectKeys<TObjectSchema>>(

schema: TObjectSchema,

keys: TKeys,

error?: string,

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

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

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.