Class VineUnion<Conditional>

constructor

• new VineUnion<Conditional extends UnionConditional<SchemaTypes>>(
      conditionals: Conditional[],
  ): VineUnion<Conditional>

  Type Parameters

  • Conditional extends UnionConditional<SchemaTypes>

  Parameters

  • conditionals: Conditional[]

  Returns VineUnion<Conditional>

[ITYPE]

[OTYPE]

[COTYPE]

optional

• optional(): VineUnion<Conditional | UnionConditional<VineOptional<undefined>>>

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

  Returns VineUnion<Conditional | UnionConditional<VineOptional<undefined>>>

nullable

• nullable(): VineUnion<Conditional | UnionConditional<VineNull>>

  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 VineUnion<Conditional | UnionConditional<VineNull>>

otherwise

• otherwise(callback: UnionNoMatchCallback<Record<string, unknown>>): this

  Define a fallback method to invoke when all of the union conditions fail. You may use this method to report an error.

  Parameters

  • callback: UnionNoMatchCallback<Record<string, unknown>>

  Returns this

clone

• clone(): this

  Clones the VineUnion schema type.

  Returns this

[PARSE]

• "[PARSE]"(
      propertyName: string,
      refs: RefsStore,
      options: ParserOptions,
  ): UnionNode

  Compiles to a union

  Parameters

  • propertyName: string
  • refs: RefsStore
  • options: ParserOptions

  Returns UnionNode