objectWithRest | /src/schemas/index.ts | valibot@v0.41.0

x/valibot/src/schemas/index.ts>objectWithRest

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

Very Popular

any array bigint blob boolean custom date enum file function instance intersect lazy literal looseObject looseTuple map nan never nonNullable nonNullish nonOptional null nullable nullish number object objectWithRest optional picklist promise record set strictObject strictTuple string symbol tuple tupleWithRest undefined undefinedable union unknown variant void

index.ts (default module)

LooseObjectSchemaAsync

LooseTupleIssue

LooseTupleSchema

LooseTupleSchemaAsync

NonNullableSchemaAsync

NonNullishIssue

NonNullishSchema

NonNullishSchemaAsync

NonOptionalIssue

NonOptionalSchema

NonOptionalSchemaAsync

ObjectWithRestSchemaAsync

StrictObjectSchemaAsync

StrictTupleIssue

StrictTupleSchema

StrictTupleSchemaAsync

TupleWithRestSchemaAsync

UndefinedableSchema

UndefinedableSchemaAsync

VariantOptionSchemaAsync

InferNonNullableInput

InferNonNullableIssue

InferNonNullableOutput

InferNonNullishInput

InferNonNullishIssue

InferNonNullishOutput

InferNonOptionalInput

InferNonOptionalIssue

InferNonOptionalOutput

InferUndefinedableOutput

InferVariantIssue

IntersectOptions

IntersectOptionsAsync

any

map

nan

set

function objectWithRest

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

objectWithRest<TEntries extends ObjectEntries, TRest extends BaseSchema<unknown, unknown, BaseIssue<unknown>>>(entries: TEntries, rest: TRest): ObjectWithRestSchema<TEntries, TRest, undefined>

Creates an object with rest schema.

objectWithRest<TEntries extends ObjectEntries, TRest extends BaseSchema<unknown, unknown, BaseIssue<unknown>>, TMessage extends ErrorMessage<ObjectWithRestIssue> | undefined>(

entries: TEntries,

rest: TRest,

message: TMessage,

): ObjectWithRestSchema<TEntries, TRest, TMessage>

Creates an object with rest schema.

Type Parameters

TEntries extends ObjectEntries

TRest extends BaseSchema<unknown, unknown, BaseIssue<unknown>>

Parameters

entries: TEntries

The entries schema.

rest: TRest

The rest schema.

Returns

ObjectWithRestSchema<TEntries, TRest, undefined>

An object with rest schema.

Creates an object with rest schema.

Type Parameters

TEntries extends ObjectEntries

TRest extends BaseSchema<unknown, unknown, BaseIssue<unknown>>

TMessage extends ErrorMessage<ObjectWithRestIssue> | undefined

Parameters

entries: TEntries

The entries schema.

rest: TRest

The rest schema.

message: TMessage

The error message.

Returns

ObjectWithRestSchema<TEntries, TRest, TMessage>

An object with rest schema.