Class VineObject<Properties, Input, Output, CamelCaseOutput>

VineObject represents an object value in the validation schema. It validates objects with predefined properties, supports conditional groups, and provides control over unknown properties.

Example

const schema = vine.object({
  name: vine.string(),
  email: vine.string().email(),
  age: vine.number().min(0)
})

const result = await vine.validate({
  schema,
  data: { name: 'John', email: 'john@example.com', age: 30 }
})

Type Parameters

Properties extends Record<string, SchemaTypes>
Record of property names to their schema types
Input
The expected input type for this object
Output
The output type after validation and transformation
CamelCaseOutput
The output type with camelCase property names

Hierarchy (View Summary)

BaseType<Input, Output, CamelCaseOutput>
- VineObject

Index

Constructors

constructor

new VineObject<
    Properties extends Record<string, SchemaTypes>,
    Input,
    Output,
    CamelCaseOutput,
>(
    properties: Properties,
    options?: FieldOptions,
    validations?: Validation<any>[],
): VineObject<Properties, Input, Output, CamelCaseOutput>
Type Parameters
- Properties extends Record<string, SchemaTypes>
- Input
- Output
- CamelCaseOutput
Parameters
- properties: Properties
- Optionaloptions: FieldOptions
- Optionalvalidations: Validation<any>[]
Returns VineObject<Properties, Input, Output, CamelCaseOutput>
Overrides BaseType.constructor
- Defined in src/schema/object/main.ts:161

Properties

[ITYPE]

"[ITYPE]": Input

Define the input type of the schema for TypeScript inference

[OTYPE]

"[OTYPE]": Output

The output value type of the field after validation. The property points to a type only and not the real value.

[COTYPE]

"[COTYPE]": CamelCaseOutput

Type marker for camelCase output type inference

[UNIQUE_NAME]

"[UNIQUE_NAME]": string = 'vine.object'

Unique name identifier for union type resolution

Methods

parse

parse(callback: ParseFn): this
Define a method to parse the input value. The method is invoked before any validation and hence you must perform type-checking to know the value you are working with.
Parameters
- callback: ParseFn
  Parser function to transform the input value
Returns this
This schema instance for method chaining
Example
```
vine.string().parse((value) => {
  return typeof value === 'string' ? value.trim() : value
})
```
Inherited from BaseType.parse
- Defined in src/schema/base/main.ts:372

use

use(validation: Validation<any> | RuleBuilder): this
Push a validation to the validations chain.
Parameters
- validation: Validation<any> | RuleBuilder
  Validation rule or rule builder to add
Returns this
This schema instance for method chaining
Example
```
vine.string().use(vine.createRule((value) => {
  return value.length > 0
}))
```
Inherited from BaseType.use
- Defined in src/schema/base/main.ts:388

bail

bail(state: boolean): VineObject<Properties, Input, Output, CamelCaseOutput>
Enable/disable the bail mode. In bail mode, the field validations are stopped after the first error.
Parameters
- state: boolean
  Whether to enable bail mode
Returns VineObject<Properties, Input, Output, CamelCaseOutput>
This schema instance for method chaining
Inherited from BaseType.bail
- Defined in src/schema/base/main.ts:400

optional

optional(): OptionalModifier<
VineObject<Properties, Input, Output, CamelCaseOutput>,
>
Mark the field under validation as optional. An optional field allows both null and undefined values.

Returns OptionalModifier<VineObject<Properties, Input, Output, CamelCaseOutput>>
A new OptionalModifier wrapping this schema
Inherited from BaseType.optional
- Defined in src/schema/base/main.ts:411

nullable

nullable(): NullableModifier<
VineObject<Properties, Input, Output, CamelCaseOutput>,
>
Mark the field under validation to be null. The null value will be written to the output as well.

If optional and nullable are used together, then both undefined and null values will be allowed.

Returns NullableModifier<VineObject<Properties, Input, Output, CamelCaseOutput>>
A new NullableModifier wrapping this schema
Inherited from BaseType.nullable
- Defined in src/schema/base/main.ts:424

[IS_OF_TYPE]

"[IS_OF_TYPE]"(value: unknown): boolean
Type checker function to determine if a value is an object. Required for "unionOfTypes" functionality.
Parameters
- value: unknown
  The value to check
Returns boolean
True if the value is a non-null object and not an array
- Defined in src/schema/object/main.ts:157

getProperties

getProperties(): Properties
Returns a clone copy of the object properties. The object groups are not copied to keep the implementations simple and easy to reason about.

Returns Properties
- Defined in src/schema/object/main.ts:176

pick

pick<Keys extends string | number | symbol>(
keys: Keys[] | readonly Keys[],
): Pick<Properties, Keys>
Returns a clone copy of the cherry picked object properties including only the mentioned properties.
Type Parameters
- Keys extends string | number | symbol
Parameters
- keys: Keys[] | readonly Keys[]
Returns Pick<Properties, Keys>
- Defined in src/schema/object/main.ts:189

omit

omit<Keys extends string | number | symbol>(
keys: Keys[] | readonly Keys[],
): Omit<Properties, Keys>
Returns a cloned copy of the cherry picked object properties without the mentioned properties
Type Parameters
- Keys extends string | number | symbol
Parameters
- keys: Keys[] | readonly Keys[]
Returns Omit<Properties, Keys>
- Defined in src/schema/object/main.ts:201

allowUnknownProperties

allowUnknownProperties<Value>(): VineObject<
    Properties,
    Input & { [K: string]: Value },
    Output & { [K: string]: Value },
    CamelCaseOutput & { [K: string]: Value },
>
Copy unknown properties to the final output.
Type Parameters
- Value
Returns VineObject<
    Properties,
    Input & { [K: string]: Value },
    Output & { [K: string]: Value },
    CamelCaseOutput & { [K: string]: Value },
>
- Defined in src/schema/object/main.ts:216

merge

merge<Group extends ObjectGroup<GroupConditional<any, any, any, any>>>(
    group: Group,
): VineObject<
    Properties,
    Input & Group[typeof ITYPE],
    Output & Group[typeof OTYPE],
    CamelCaseOutput & Group[typeof COTYPE],
>
Merge a union to the object groups. The union can be a "vine.union" with objects, or a "vine.object.union" with properties.
Type Parameters
- Group extends ObjectGroup<GroupConditional<any, any, any, any>>
Parameters
- group: Group
Returns VineObject<
    Properties,
    Input & Group[typeof ITYPE],
    Output & Group[typeof OTYPE],
    CamelCaseOutput & Group[typeof COTYPE],
>
- Defined in src/schema/object/main.ts:235

clone

clone(): this
Clone object

Returns this
Overrides BaseType.clone
- Defined in src/schema/object/main.ts:255

toCamelCase

toCamelCase(): VineCamelCaseObject<
VineObject<Properties, Input, Output, CamelCaseOutput>,
>
Applies camelcase transform

Returns VineCamelCaseObject<VineObject<Properties, Input, Output, CamelCaseOutput>>
- Defined in src/schema/object/main.ts:273

[PARSE]

"[PARSE]"(
    propertyName: string,
    refs: RefsStore,
    options: ParserOptions,
): ObjectNode
Compiles the schema type to a compiler node
Parameters
- propertyName: string
- refs: RefsStore
- options: ParserOptions
Returns ObjectNode
Overrides BaseType.[PARSE]
- Defined in src/schema/object/main.ts:280

Class VineObject<Properties, Input, Output, CamelCaseOutput>

Example

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns VineObject<Properties, Input, Output, CamelCaseOutput>

Properties

[ITYPE]

[OTYPE]

[COTYPE]

[UNIQUE_NAME]

Methods

parse

Parameters

Returns this

Example

use

Parameters

Returns this

Example

bail

Parameters

Returns VineObject<Properties, Input, Output, CamelCaseOutput>

optional

Returns OptionalModifier<VineObject<Properties, Input, Output, CamelCaseOutput>>

nullable

Returns NullableModifier<VineObject<Properties, Input, Output, CamelCaseOutput>>

[IS_OF_TYPE]

Parameters

Returns boolean

getProperties

Returns Properties

pick

Type Parameters

Parameters

Returns Pick<Properties, Keys>

omit

Type Parameters

Parameters

Returns Omit<Properties, Keys>

allowUnknownProperties

Type Parameters

Returns VineObject< Properties, Input & { [K: string]: Value }, Output & { [K: string]: Value }, CamelCaseOutput & { [K: string]: Value },>

merge

Type Parameters

Parameters

Returns VineObject< Properties, Input & Group[typeof ITYPE], Output & Group[typeof OTYPE], CamelCaseOutput & Group[typeof COTYPE],>

clone

Returns this

toCamelCase

Returns VineCamelCaseObject<VineObject<Properties, Input, Output, CamelCaseOutput>>

[PARSE]

Parameters

Returns ObjectNode

Settings

On This Page

Returns VineObject<
Properties,
Input & { [K: string]: Value },
Output & { [K: string]: Value },
CamelCaseOutput & { [K: string]: Value },
>

Returns VineObject<
Properties,
Input & Group[typeof ITYPE],
Output & Group[typeof OTYPE],
CamelCaseOutput & Group[typeof COTYPE],
>