Class VineTuple<Schema, Input, Output, CamelCaseOutput>

[ITYPE]

[OTYPE]

[COTYPE]

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
  })
  Copy

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
  }))
  Copy

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

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

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