union

Creates an union schema.

I recommend that you read the unions guide before using this schema function.

const Schema = v.union<TOptions, TMessage>(options, message);

Generics

• TOptions extends UnionOptions
• TMessage extends ErrorMessage<UnionIssue<InferIssue<TOptions[number]>>> | undefined

Parameters

• options TOptions
• message TMessage

Explanation

With union you can validate if the input matches one of the given options. If the input does not match a schema and cannot be clearly assigned to one of the options, you can use message to customize the error message.

If a bad input can be uniquely assigned to one of the schemas based on the data type, the result of that schema is returned. Otherwise, a general issue is returned that contains the issues of each schema as subissues. This is a special case within the library, as the issues of union can contradict each other.

Returns

• Schema UnionSchema<TOptions, TMessage>

Examples

The following examples show how union can be used.

URL schema

Schema to validate an URL or empty string.

const UrlSchema = v.union([v.pipe(v.string(), v.url()), v.literal('')]);

Number schema

Schema to validate a number or decimal string.

const NumberSchema = v.union([v.number(), v.pipe(v.string(), v.decimal())]);

Date schema

Schema to validate a Date or ISO timestamp.

const DateSchema = v.union([v.date(), v.pipe(v.string(), v.isoTimestamp())]);

Related

The following APIs can be combined with union.

Schemas

• any,
• array,
• bigint,
• blob,
• boolean,
• custom,
• date,
• enum,
• file,
• function,
• instance,
• intersect,
• lazy,
• literal,
• looseObject,
• looseTuple,
• map,
• nan,
• never,
• nonNullable,
• nonNullish,
• nonOptional,
• null,
• nullable,
• nullish,
• number,
• object,
• objectWithRest,
• optional,
• picklist,
• promise,
• record,
• set,
• strictObject,
• strictTuple,
• string,
• symbol,
• tuple,
• tupleWithRest,
• undefined,
• union,
• unknown,
• variant,
• void

Methods

• config,
• fallback,
• getDefault,
• getDefaults,
• getFallback,
• getFallbacks,
• is,
• parse,
• parser,
• pipe,
• safeParse,
• safeParser

Actions

• base64,
• bic,
• brand,
• bytes,
• check,
• checkItems,
• creditCard,
• cuid2,
• decimal,
• email,
• emoji,
• empty,
• endsWith,
• everyItem,
• excludes,
• filterItems,
• findItem,
• finite,
• hash,
• hexadecimal,
• hexColor,
• imei,
• includes,
• integer,
• ip,
• ipv4,
• ipv6,
• isoDate,
• isoDateTime,
• isoTime,
• isoTimeSecond,
• isoTimestamp,
• isoWeek,
• length,
• mac,
• mac48,
• mac64,
• mapItems,
• maxBytes,
• maxLength,
• maxSize,
• maxValue,
• mimeType,
• minBytes,
• minLength,
• minSize,
• minValue,
• multipleOf,
• nonEmpty,
• notBytes,
• notLength,
• notSize,
• notValue,
• octal,
• partialCheck,
• rawCheck,
• rawTransform,
• readonly,
• reduceItems,
• regex,
• safeInteger,
• size,
• someItem,
• sortItem,
• startsWith,
• toLowerCase,
• toMaxValue,
• toMinValue,
• toUpperCase,
• transform,
• trim,
• trimEnd,
• trimStart,
• ulid,
• url,
• uuid,
• value

Utils

• entriesFromList,
• isOfKind,
• isOfType