brand

Brands the output type of a schema.

const Schema = brand<TSchema, TName>(schema, name);

Generics

• TSchema extends BaseSchema
• TName extends BrandName

Parameters

• schema TSchema
• name TName

Explanation

brand allows you to brand the output type of schema with name. This ensures that data can only be considered valid if it has been validated by a particular branded schema.

Returns

• Schema SchemaWithBrand<TSchema, TName>

Examples

The following examples show how brand can be used.

Branded fruit schema

Schema to ensure that only a validated fruit is accepted.

// Create schema and infer output type
const FruitSchema = brand(object({ name: string() }), 'Fruit');
type FruitOutput = Output<typeof FruitSchema>;

// This works because output is branded
const apple: FruitOutput = parse(FruitSchema, { name: 'apple' });

// But this will result in a type error
const banana: FruitOutput = { name: 'banana' };

Related

The following APIs can be combined with brand.

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,
• set,
• special,
• string,
• symbol,
• tuple,
• undefined_,
• union,
• unknown,
• variant,
• void_

Methods

• coerce,
• fallback,
• getDefault,
• getDefaults,
• getFallback,
• getFallbacks,
• is,
• keyof,
• merge,
• omit,
• parse,
• partial,
• pick,
• required,
• safeParse,
• transform,
• unwrap