set

Creates a set schema.

// Set schema with an optional pipe
const Schema = set<TValue>(value, pipe);

// Set schema with an optional message and pipe
const Schema = set<TValue>(value, message, pipe);

Generics

• TValue extends BaseSchema

Parameters

• value TValue
• message ErrorMessage | undefined
• pipe Pipe<SetOutput<TValue>> | undefined

Explanation

With set you can validate the data type of the input and whether the content matches value. With pipe you can transform and validate the further details of the set. If the input is not a set, you can use message to customize the error message.

Returns

• Schema SetSchema<TValue>

Examples

The following examples show how set can be used.

String set schema

Schema to validate a set with string values.

const StringSetSchema = set(string());

Object set schema

Schema to validate a set with object values.

const ObjectSetSchema = set(object({ key: string() }));

Related

The following APIs can be combined with set.

Schemas

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

Methods

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

Transformations

• toCustom

Validations

• custom,
• maxSize,
• minSize,
• notSize,
• size