Class VineLiteral<Value>

[ITYPE]

[OTYPE]

[COTYPE]

OptionaldataTypeValidator

class StringSchema extends BaseLiteralType {
  dataTypeValidator = stringDataTypeRule
}
Copy

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 it.

  Parameters

  • callback: ParseFn

  Returns this

use

• use(validation: Validation<any> | RuleBuilder): this

  Adds a validation rule to the schema's validation chain. Rules are executed in the order they are added.

  Parameters

  • validation: Validation<any> | RuleBuilder

    The validation rule or rule builder to add

  Returns this

  This schema instance for method chaining

  Example

  vine.string().use(minLength({ length: 3 }))
  vine.number().use(customRule({ strict: true }))
  Copy

bail

• bail(state: boolean): VineLiteral<Value>

  Enable/disable bail mode for this field. In bail mode, field validations stop after the first error.

  Parameters

  • state: boolean

    Whether to enable bail mode

  Returns VineLiteral<Value>

  This schema instance for method chaining

  Example

  vine.string().bail(false) // Continue validation after first error
  vine.number().bail(true)  // Stop after first error (default)
  Copy

optional

• optional(): OptionalModifier<VineLiteral<Value>>

  Mark the field under validation as optional. An optional field allows both null and undefined values.

  Returns OptionalModifier<VineLiteral<Value>>

nullable

• nullable(): NullableModifier<VineLiteral<Value>>

  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<VineLiteral<Value>>

transform

• transform<TransformedOutput>(
      transformer: Transformer<VineLiteral<Value>, TransformedOutput>,
  ): TransformModifier<VineLiteral<Value>, TransformedOutput>

  Apply transform on the final validated value. The transform method may convert the value to any new datatype.

  Type Parameters

  • TransformedOutput

  Parameters

  • transformer: Transformer<VineLiteral<Value>, TransformedOutput>

  Returns TransformModifier<VineLiteral<Value>, TransformedOutput>

[PARSE]

• "[PARSE]"(
      propertyName: string,
      refs: RefsStore,
      options: ParserOptions,
  ): FieldNode & {} & { subtype: string }

  Compiles the literal schema type into a compiler node. This method transforms the schema definition into a format that the validation compiler can process.

  Parameters

  • propertyName: string

    Name of the property being compiled

  • refs: RefsStore

    Reference store for the compiler

  • options: ParserOptions

    Parser options including camelCase conversion

  Returns FieldNode & {} & { subtype: string }

  Compiled literal node with subtype information