Class VineUnionOfTypes<Schema>

constructor

• new VineUnionOfTypes<Schema extends SchemaTypes>(
      schemas: Schema[],
  ): VineUnionOfTypes<Schema>

  Type Parameters

  • Schema extends SchemaTypes

  Parameters

  • schemas: Schema[]

  Returns VineUnionOfTypes<Schema>

[ITYPE]

[OTYPE]

[COTYPE]

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 VineUnionOfTypes schema type.

  Returns this

optional

• optional(): VineUnionOfTypes<VineOptional<undefined> | Schema>

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

  Returns VineUnionOfTypes<VineOptional<undefined> | Schema>

nullable

• nullable(): VineUnionOfTypes<VineNull | Schema>

  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 VineUnionOfTypes<VineNull | Schema>

[PARSE]

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

  Compiles to a union

  Parameters

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

  Returns UnionNode