Skip to main content
Using Deno in production at your company? Earn free Deno merch.
Give us feedback
Module

x/valibot/src/methods/brand/index.ts>brand

The modular and type safe schema library for validating structural data 🤖
Extremely Popular
Go to Latest
function brand
import { brand } from "https://deno.land/x/valibot@v0.13.0/src/methods/brand/index.ts";

Type Parameters

TSchema extends AnySchema
TBrandName extends BrandName

Returns

AnySchema<Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends AnySchemaAsync
TBrandName extends BrandName

Returns

AnySchemaAsync<Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends ArraySchema<any>
TBrandName extends BrandName

Returns

ArraySchema<TSchema["array"]["item"], Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends ArraySchemaAsync<any>
TBrandName extends BrandName

Returns

ArraySchemaAsync<TSchema["array"]["item"], Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends BigintSchema
TBrandName extends BrandName

Returns

BigintSchema<Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends BigintSchemaAsync
TBrandName extends BrandName

Returns

BigintSchemaAsync<Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends BlobSchema
TBrandName extends BrandName

Returns

BlobSchema<Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends BlobSchemaAsync
TBrandName extends BrandName

Returns

BlobSchemaAsync<Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends BooleanSchema
TBrandName extends BrandName

Returns

BooleanSchema<Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends BooleanSchemaAsync
TBrandName extends BrandName

Returns

BooleanSchemaAsync<Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends DateSchema
TBrandName extends BrandName

Returns

DateSchema<Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends DateSchemaAsync
TBrandName extends BrandName

Returns

DateSchemaAsync<Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends EnumSchema<any>
TBrandName extends BrandName

Returns

EnumSchema<TSchema["enum"], Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends EnumSchemaAsync<any>
TBrandName extends BrandName

Returns

EnumSchemaAsync<TSchema["enum"], Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends InstanceSchema<any>
TBrandName extends BrandName

Returns

InstanceSchema<TSchema["class"], Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends InstanceSchemaAsync<any>
TBrandName extends BrandName

Returns

InstanceSchemaAsync<TSchema["class"], Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends LiteralSchema<any>
TBrandName extends BrandName

Returns

LiteralSchema<TSchema["literal"], Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends LiteralSchemaAsync<any>
TBrandName extends BrandName

Returns

LiteralSchemaAsync<TSchema["literal"], Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends MapSchema<any, any>
TBrandName extends BrandName

Returns

MapSchema<TSchema["map"]["key"], TSchema["map"]["value"], Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends MapSchemaAsync<any, any>
TBrandName extends BrandName

Returns

MapSchemaAsync<TSchema["map"]["key"], TSchema["map"]["value"], Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends NanSchema
TBrandName extends BrandName

Returns

NanSchema<Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends NanSchemaAsync
TBrandName extends BrandName

Returns

NanSchemaAsync<Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends NativeEnumSchema<any>
TBrandName extends BrandName

Returns

NativeEnumSchema<TSchema["nativeEnum"], Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends NativeEnumSchemaAsync<any>
TBrandName extends BrandName

Returns

NativeEnumSchemaAsync<TSchema["nativeEnum"], Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends NeverSchema

Parameters

schema: TSchema
action: (value: Output<TSchema>) => never

Returns

NeverSchema

Type Parameters

TSchema extends NeverSchemaAsync

Parameters

schema: TSchema
action: (value: Output<TSchema>) => never

Returns

NeverSchemaAsync

Type Parameters

TSchema extends NonNullableSchema<any>
TBrandName extends BrandName

Returns

NonNullableSchema<TSchema["wrapped"], Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends NonNullableSchemaAsync<any>
TBrandName extends BrandName

Returns

NonNullableSchemaAsync<TSchema["wrapped"], Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends NonNullishSchema<any>
TBrandName extends BrandName

Returns

NonNullishSchema<TSchema["wrapped"], Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends NonNullishSchemaAsync<any>
TBrandName extends BrandName

Returns

NonNullishSchemaAsync<TSchema["wrapped"], Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends NonOptionalSchema<any>
TBrandName extends BrandName

Returns

NonOptionalSchema<TSchema["wrapped"], Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends NonOptionalSchemaAsync<any>
TBrandName extends BrandName

Returns

NonOptionalSchemaAsync<TSchema["wrapped"], Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends NullSchema
TBrandName extends BrandName

Returns

NullSchema<Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends NullSchemaAsync
TBrandName extends BrandName

Returns

NullSchemaAsync<Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends NullableSchema<any>
TBrandName extends BrandName

Returns

NullableSchema<TSchema["wrapped"], Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends NullableSchemaAsync<any>
TBrandName extends BrandName

Returns

NullableSchemaAsync<TSchema["wrapped"], Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends NullishSchema<any>
TBrandName extends BrandName

Returns

NullishSchema<TSchema["wrapped"], Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends NullishSchemaAsync<any>
TBrandName extends BrandName

Returns

NullishSchemaAsync<TSchema["wrapped"], Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends NumberSchema
TBrandName extends BrandName

Returns

NumberSchema<Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends NumberSchemaAsync
TBrandName extends BrandName

Returns

NumberSchemaAsync<Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends ObjectSchema<any>
TBrandName extends BrandName

Returns

ObjectSchema<TSchema["object"], Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends ObjectSchemaAsync<any>
TBrandName extends BrandName

Returns

ObjectSchemaAsync<TSchema["object"], Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends OptionalSchema<any>
TBrandName extends BrandName

Returns

OptionalSchema<TSchema["wrapped"], Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends OptionalSchemaAsync<any>
TBrandName extends BrandName

Returns

OptionalSchemaAsync<TSchema["wrapped"], Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends RecordSchema<any, any>
TBrandName extends BrandName

Returns

RecordSchema<TSchema["record"]["key"], TSchema["record"]["value"], Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends RecordSchemaAsync<any, any>
TBrandName extends BrandName

Returns

RecordSchemaAsync<TSchema["record"]["key"], TSchema["record"]["value"], Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends RecursiveSchema<any>
TBrandName extends BrandName

Returns

RecursiveSchema<TSchema["getter"], Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends RecursiveSchemaAsync<any>
TBrandName extends BrandName

Returns

RecursiveSchemaAsync<TSchema["getter"], Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends SetSchema<any>
TBrandName extends BrandName

Returns

SetSchema<TSchema["set"]["value"], Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends SetSchemaAsync<any>
TBrandName extends BrandName

Returns

SetSchemaAsync<TSchema["set"]["value"], Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends SpecialSchema<any>
TBrandName extends BrandName

Returns

SpecialSchema<Input<TSchema>, Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends SpecialSchemaAsync<any>
TBrandName extends BrandName

Returns

SpecialSchemaAsync<Input<TSchema>, Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends StringSchema
TBrandName extends BrandName

Returns

StringSchema<Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends StringSchemaAsync
TBrandName extends BrandName

Returns

StringSchemaAsync<Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends SymbolSchema
TBrandName extends BrandName

Returns

SymbolSchema<Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends SymbolSchemaAsync
TBrandName extends BrandName

Returns

SymbolSchemaAsync<Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends TupleSchema<any, any>
TBrandName extends BrandName

Returns

TupleSchema<TSchema["tuple"]["items"], TSchema["tuple"]["rest"], Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends TupleSchemaAsync<any, any>
TBrandName extends BrandName

Returns

TupleSchemaAsync<TSchema["tuple"]["items"], TSchema["tuple"]["rest"], Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends UndefinedSchema
TBrandName extends BrandName

Returns

UndefinedSchema<Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends UndefinedSchemaAsync
TBrandName extends BrandName

Returns

UndefinedSchemaAsync<Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends UnionSchema<any>
TBrandName extends BrandName

Returns

UnionSchema<TSchema["union"], Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends UnionSchemaAsync<any>
TBrandName extends BrandName

Returns

UnionSchemaAsync<TSchema["union"], Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends UnknownSchema
TBrandName extends BrandName

Returns

UnknownSchema<Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends UnknownSchemaAsync
TBrandName extends BrandName

Returns

UnknownSchemaAsync<Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends VoidSchema
TBrandName extends BrandName

Returns

VoidSchema<Output<TSchema> & Brand<TBrandName>>

Type Parameters

TSchema extends VoidSchemaAsync
TBrandName extends BrandName

Returns

VoidSchemaAsync<Output<TSchema> & Brand<TBrandName>>