Class VineTuple<Schema, Input, Output, CamelCaseOutput>

VineTuple represents a fixed-length array where each position has a specific schema type. Unlike VineArray which uses the same schema for all elements, tuples allow different types at different positions, similar to TypeScript tuples.

Example

const schema = vine.tuple([
  vine.string(),
  vine.number(),
  vine.boolean()
])

const result = await vine.validate({
  schema,
  data: ['hello', 42, true]
})

Type Parameters

Schema extends SchemaTypes[]
Array of schema types for each tuple position
Input extends any[]
Expected input type for the tuple
Output extends any[]
Output type after validation and transformation
CamelCaseOutput extends any[]
Output type with camelCase property names

Hierarchy (View Summary)

BaseType<Input, Output, CamelCaseOutput>
- VineTuple

Implements

WithJSONSchema

Index

Constructors

constructor

new VineTuple<
    Schema extends SchemaTypes[],
    Input extends any[],
    Output extends any[],
    CamelCaseOutput extends any[],
>(
    schemas: [...Schema[]],
    options?: FieldOptions,
    validations?: Validation<any>[],
): VineTuple<Schema, Input, Output, CamelCaseOutput>
Creates a new VineTuple instance with position-specific schemas.
Type Parameters
- Schema extends SchemaTypes[]
  Array of schema types for each tuple position
- Input extends any[]
  Expected input type for the tuple
- Output extends any[]
  Output type after validation and transformation
- CamelCaseOutput extends any[]
  Output type with camelCase property names
Parameters
- schemas: [...Schema[]]
  Array of schemas defining validation for each tuple position
- Optionaloptions: FieldOptions
  Field options like bail mode and nullability
- Optionalvalidations: Validation<any>[]
  Initial set of validations to apply
Returns VineTuple<Schema, Input, Output, CamelCaseOutput>
Overrides BaseType.constructor
- Defined in src/schema/tuple/main.ts:88

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.array'

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:511

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:527

bail

bail(state: boolean): VineTuple<Schema, 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 VineTuple<Schema, Input, Output, CamelCaseOutput>
This schema instance for method chaining
Inherited from BaseType.bail
- Defined in src/schema/base/main.ts:539

optional

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

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

nullable

nullable(): NullableModifier<VineTuple<Schema, 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<VineTuple<Schema, Input, Output, CamelCaseOutput>>
A new NullableModifier wrapping this schema
Inherited from BaseType.nullable
- Defined in src/schema/base/main.ts:563

[IS_OF_TYPE]

"[IS_OF_TYPE]"(value: unknown): value is any[]
Type checker function to determine if a value is an array. Required for "unionOfTypes" functionality.
Parameters
- value: unknown
  The value to check
Returns value is any[]
True if the value is an array
- Defined in src/schema/tuple/main.ts:77

allowUnknownProperties

allowUnknownProperties<Value>(): VineTuple<
    Schema,
    [...Input[], ...Value[]],
    [...Output[], ...Value[]],
    [...CamelCaseOutput[], ...Value[]],
>
Allows additional elements beyond the defined tuple length to pass through validation. By default, tuples enforce exact length matching. This method relaxes that constraint.
Type Parameters
- Value
Returns VineTuple<
    Schema,
    [...Input[], ...Value[]],
    [...Output[], ...Value[]],
    [...CamelCaseOutput[], ...Value[]],
>
This tuple schema with unknown properties allowed
Example
```
const schema = vine.tuple([
  vine.string(),
  vine.number()
]).allowUnknownProperties()

// Now ['hello', 42, 'extra'] will pass validation
```
- Defined in src/schema/tuple/main.ts:107

clone

clone(): this
Clones the VineTuple schema including all position schemas, validations, and options.

Returns this
A cloned instance of this VineTuple schema
Overrides BaseType.clone
- Defined in src/schema/tuple/main.ts:127

toJSONSchema

toJSONSchema(): JSONSchema7
Converts the tuple schema to JSON Schema format.

Returns JSONSchema7
JSON Schema representation of this tuple
Implementation of WithJSONSchema.toJSONSchema
Overrides BaseType.toJSONSchema
- Defined in src/schema/tuple/main.ts:146

[PARSE]

"[PARSE]"(
    propertyName: string,
    refs: RefsStore,
    options: ParserOptions,
): TupleNode
Compiles the tuple schema to a compiler node for validation.
Parameters
- propertyName: string
  Name of the property being compiled
- refs: RefsStore
  Reference store for the compiler
- options: ParserOptions
  Parser options
Returns TupleNode
Compiled tuple node for validation
Overrides BaseType.[PARSE]
- Defined in src/schema/tuple/main.ts:181

Class VineTuple<Schema, Input, Output, CamelCaseOutput>

Example

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns VineTuple<Schema, Input, Output, CamelCaseOutput>

Properties

[ITYPE]

[OTYPE]

[COTYPE]

[UNIQUE_NAME]

Methods

parse

Parameters

Returns this

Example

use

Parameters

Returns this

Example

bail

Parameters

Returns VineTuple<Schema, Input, Output, CamelCaseOutput>

optional

Returns OptionalModifier<VineTuple<Schema, Input, Output, CamelCaseOutput>>

nullable

Returns NullableModifier<VineTuple<Schema, Input, Output, CamelCaseOutput>>

meta

Parameters

Returns MetaModifier<VineTuple<Schema, Input, Output, CamelCaseOutput>>

[IS_OF_TYPE]

Parameters

Returns value is any[]

allowUnknownProperties

Type Parameters

Returns VineTuple< Schema, [...Input[], ...Value[]], [...Output[], ...Value[]], [...CamelCaseOutput[], ...Value[]],>

Example

clone

Returns this

toJSONSchema

Returns JSONSchema7

[PARSE]

Parameters

Returns TupleNode

Settings

On This Page

Returns VineTuple<
Schema,
[...Input[], ...Value[]],
[...Output[], ...Value[]],
[...CamelCaseOutput[], ...Value[]],
>