Class UnionSchemaBuilder<TOptions, TRequired, TExplicitType>

Union schema builder class. Allows to create schemas containing alternatives. E.g. string | number | Date. Use it when you want to define a schema for a value that can be of different types. The type of the value will be determined by the first schema that succeeds validation. Any schema type can be supplied as variant. Which means that you are not limited to primitive types and can construct complex types as well, e.g. object | array.

NOTE this class is exported only to give opportunity to extend it by inheriting. It is not recommended to create an instance of this class directly. Use () function instead.

Example

const schema = union(string('foo')).or(string('bar'));
const result = await schema.validate('foo');
// result.valid === true
// result.object === 'foo'
Copy

Example

const schema = union(string('foo')).or(string('bar'));
const result = await schema.validate('baz');
// result.valid === false
Copy

Example

const schema = union(string('yes')).or(string('no')).or(number(0)).or(number(1));
// equals to 'yes' | 'no' | 0 | 1 in TS
const result = await schema.validate('yes');
// result.valid === true
// result.object === 'yes'

const result2 = await schema.validate(0);
// result2.valid === true
// result2.object === 0

const result3 = await schema.validate('baz');
// result3.valid === false

const result4 = await schema.validate(2);
// result4.valid === false
Copy

See

union