intersect

Creates an intersect schema.

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

// Intersect schema with an optional pipe
const Schema = intersect<TOptions>(options, pipe);

// Intersect schema with an optional message and pipe
const Schema = intersect<TOptions>(options, message, pipe);

Generics

• TOptions extends IntersectOptions

Parameters

• options TOptions
• message ErrorMessage | undefined
• pipe Pipe<IntersectOutput<TOptions>> | undefined

Explanation

With intersect you can validate if the input matches each of the given options. With pipe you can transform and validate the further details of the intersection. If the output of the intersection cannot be successfully merged, you can use message to customize the error message.

Returns

• Schema IntersectSchema<TOptions>

Examples

The following examples show how intersect can be used.

Object intersection

Schema that combines two object schemas.

const ObjectSchema = intersect([
  object({ foo: string() }),
  object({ bar: number() }),
]);

Related

The following APIs can be combined with intersect.

Schemas

• any,
• array,
• bigint,
• blob,
• boolean,
• date,
• enum_,
• instance,
• lazy,
• literal,
• map,
• nan,
• never,
• nonNullable,
• nonNullish,
• nonOptional,
• null_,
• nullable,
• nullish,
• number,
• object,
• optional,
• picklist,
• record,
• set,
• special,
• string,
• symbol,
• tuple,
• undefined_,
• union,
• intersect,
• unknown,
• variant,
• void_

Methods

• brand,
• coerce,
• fallback,
• getDefault,
• getDefaults,
• getFallback,
• getFallbacks,
• is,
• parse,
• safeParse,
• transform

Transformations

• toCustom,
• toLowerCase,
• toMaxValue,
• toMinValue,
• toTrimmed,
• toTrimmedEnd,
• toTrimmedStart,
• toUpperCase

Validations

• bic,
• bytes,
• creditCard,
• cuid2,
• custom,
• decimal,
• email,
• emoji,
• endsWith,
• every,
• excludes,
• finite,
• hash,
• hexadecimal,
• hexColor,
• imei,
• includes,
• integer,
• ip,
• ipv4,
• ipv6,
• isoDate,
• isoDateTime,
• isoTime,
• isoTimeSecond,
• isoTimestamp,
• isoWeek,
• length,
• mac,
• mac48,
• mac64,
• maxBytes,
• maxLength,
• maxSize,
• maxValue,
• mimeType,
• minBytes,
• minLength,
• minSize,
• minValue,
• multipleOf,
• notBytes,
• notLength,
• notSize,
• notValue,
• octal,
• regex,
• safeInteger,
• size,
• some,
• startsWith,
• ulid,
• url,
• uuid,
• value