x-to-zod / ZodBuilder / EmojiBuilder

Class: EmojiBuilder

Defined in: src/ZodBuilder/emoji.ts:20

EmojiBuilder: represents z.emoji() in Zod v4.

In v4, emoji validation is a top-level function that provides better type inference and tree-shaking compared to v3's z.string().emoji() method chain.

Example

// v4 mode
const emoji = new EmojiBuilder({ zodVersion: 'v4' });
emoji.text(); // => 'z.emoji()'

Extends

• StringFormatBuilder<ZodEmoji, [Parameters<typeof z.emoji>[0]]>

Implements

• BuilderFor<ZodEmoji>

Constructors

Constructor

new EmojiBuilder(version?, params?): EmojiBuilder;

Defined in: src/ZodBuilder/emoji.ts:29

Parameters

version?

"v3" | "v4"

params?

| string | { abort?: boolean; error?: | string | $ZodErrorMap<NonNullable<$ZodIssueInvalidStringFormat | $ZodIssueInvalidType<unknown>>>; message?: string; pattern?: RegExp; }

string

---

Type Literal

{ abort?: boolean; error?: | string | $ZodErrorMap<NonNullable<$ZodIssueInvalidStringFormat | $ZodIssueInvalidType<unknown>>>; message?: string; pattern?: RegExp; }

abort?

boolean

If true, no later checks will be executed if this check fails. Default false.

error?

| string | $ZodErrorMap<NonNullable<$ZodIssueInvalidStringFormat | $ZodIssueInvalidType<unknown>>>

message?

string

Deprecated

This parameter is deprecated. Use error instead.

pattern?

RegExp

Returns

EmojiBuilder

Overrides

StringFormatBuilder<
		ZodEmoji,
		[params?: Parameters<typeof z.emoji>[0]]
	>.constructor

Properties

_base64?

optional _base64?: {
  params?: unknown;
} = undefined;

Defined in: src/ZodBuilder/StringFormatBuilder.ts:24

params?

optional params?: unknown;

Inherited from

StringFormatBuilder._base64

---

_brandText?

optional _brandText?: string = undefined;

Defined in: src/ZodBuilder/BaseBuilder.ts:125

Inherited from

NumberBuilder._brandText

---

_defaultValue?

optional _defaultValue?: unknown = undefined;

Defined in: src/ZodBuilder/BaseBuilder.ts:122

Inherited from

NumberBuilder._defaultValue

---

_describeText?

optional _describeText?: string = undefined;

Defined in: src/ZodBuilder/BaseBuilder.ts:124

Inherited from

NumberBuilder._describeText

---

_fallbackText?

optional _fallbackText?: unknown = undefined;

Defined in: src/ZodBuilder/BaseBuilder.ts:126

Inherited from

NumberBuilder._fallbackText

---

_format?

optional _format?: {
  format: string;
  params?: unknown;
} = undefined;

Defined in: src/ZodBuilder/StringFormatBuilder.ts:20

format

format: string;

params?

optional params?: unknown;

Inherited from

StringFormatBuilder._format

---

_json?

optional _json?: {
  params?: unknown;
} = undefined;

Defined in: src/ZodBuilder/StringFormatBuilder.ts:25

params?

optional params?: unknown;

Inherited from

StringFormatBuilder._json

---

_maxLength?

optional _maxLength?: {
  params?: unknown;
  value: number;
} = undefined;

Defined in: src/ZodBuilder/StringFormatBuilder.ts:23

params?

optional params?: unknown;

value

value: number;

Inherited from

StringFormatBuilder._maxLength

---

_metaData?

optional _metaData?: Record<string, unknown> = undefined;

Defined in: src/ZodBuilder/BaseBuilder.ts:130

Inherited from

NumberBuilder._metaData

---

_minLength?

optional _minLength?: {
  params?: unknown;
  value: number;
} = undefined;

Defined in: src/ZodBuilder/StringFormatBuilder.ts:22

params?

optional params?: unknown;

value

value: number;

Inherited from

StringFormatBuilder._minLength

---

_nullable

_nullable: boolean = false;

Defined in: src/ZodBuilder/BaseBuilder.ts:120

Inherited from

NumberBuilder._nullable

---

_optional

_optional: boolean = false;

Defined in: src/ZodBuilder/BaseBuilder.ts:119

Inherited from

NumberBuilder._optional

---

_params?

protected optional _params?: [
  | string
  | {
  abort?: boolean;
  error?:   | string
     | $ZodErrorMap<NonNullable<$ZodIssueInvalidStringFormat | $ZodIssueInvalidType<unknown>>>;
  message?: string;
  pattern?: RegExp;
}];

Defined in: src/ZodBuilder/BaseBuilder.ts:118

Inherited from

StringFormatBuilder._params

---

_pattern?

optional _pattern?: {
  params?: unknown;
  pattern: string;
} = undefined;

Defined in: src/ZodBuilder/StringFormatBuilder.ts:21

params?

optional params?: unknown;

pattern

pattern: string;

Inherited from

StringFormatBuilder._pattern

---

_pipe?

optional _pipe?: {
  contentSchema: Builder;
  params?: unknown;
} = undefined;

Defined in: src/ZodBuilder/StringFormatBuilder.ts:26

contentSchema

contentSchema: Builder;

params?

optional params?: unknown;

Inherited from

StringFormatBuilder._pipe

---

_readonly

_readonly: boolean = false;

Defined in: src/ZodBuilder/BaseBuilder.ts:121

Inherited from

NumberBuilder._readonly

---

_refineFn?

optional _refineFn?: string = undefined;

Defined in: src/ZodBuilder/BaseBuilder.ts:127

Inherited from

NumberBuilder._refineFn

---

_refineMessage?

optional _refineMessage?: string = undefined;

Defined in: src/ZodBuilder/BaseBuilder.ts:128

Inherited from

NumberBuilder._refineMessage

---

_superRefineFns

_superRefineFns: string[] = [];

Defined in: src/ZodBuilder/BaseBuilder.ts:129

Inherited from

NumberBuilder._superRefineFns

---

_transformFn?

optional _transformFn?: string = undefined;

Defined in: src/ZodBuilder/BaseBuilder.ts:131

Inherited from

NumberBuilder._transformFn

---

_version?

protected optional _version?: "v3" | "v4";

Defined in: src/ZodBuilder/BaseBuilder.ts:133

Inherited from

StringFormatBuilder._version

---

typeKind

readonly typeKind: "emoji";

Defined in: src/ZodBuilder/emoji.ts:27

Implementation of

BuilderFor.typeKind

Overrides

StringFormatBuilder.typeKind

Accessors

zodVersion

Get Signature

get protected zodVersion(): ZodVersion;

Defined in: src/ZodBuilder/BaseBuilder.ts:144

Get the target Zod version for code generation.

Returns

ZodVersion

'v3' or 'v4' (default: 'v4')

Inherited from

StringFormatBuilder.zodVersion

Methods

base()

protected base(): string;

Defined in: src/ZodBuilder/emoji.ts:36

Compute the type-specific base schema string.

This is the core abstract method in the template method pattern. Subclasses must implement this to provide their type-specific schema string (e.g., "z.string()", "z.number()", "z.object({...})").

The base schema string returned by this method will then have shared modifiers applied via the modify() method when text() is called.

Returns

string

The base Zod schema string without any modifiers applied

Overrides

StringFormatBuilder.base

---

brand()

brand(brand): this;

Defined in: src/ZodBuilder/BaseBuilder.ts:232

Apply brand modifier.

Parameters

brand

string

Returns

this

Implementation of

BuilderFor.brand

Inherited from

StringFormatBuilder.brand

---

catch()

catch(fallback): this;

Defined in: src/ZodBuilder/BaseBuilder.ts:248

Apply catch modifier.

Parameters

fallback

unknown

Returns

this

Implementation of

BuilderFor.catch

Inherited from

StringFormatBuilder.catch

---

date()

date(_params?): this;

Defined in: src/ZodBuilder/StringFormatBuilder.ts:133

Parameters

_params?

unknown

Returns

this

Inherited from

StringFormatBuilder.date

---

datetime()

datetime(_params?): this;

Defined in: src/ZodBuilder/StringFormatBuilder.ts:127

Parameters

_params?

unknown

Returns

this

Inherited from

StringFormatBuilder.datetime

---

default()

default(value): this;

Defined in: src/ZodBuilder/BaseBuilder.ts:212

Apply default value.

Parameters

value

unknown

Returns

this

Implementation of

BuilderFor.default

Inherited from

StringFormatBuilder.default

---

describe()

describe(description): this;

Defined in: src/ZodBuilder/BaseBuilder.ts:220

Apply describe modifier.

Parameters

description

string

Returns

this

Implementation of

BuilderFor.describe

Inherited from

StringFormatBuilder.describe

---

duration()

duration(_params?): this;

Defined in: src/ZodBuilder/StringFormatBuilder.ts:136

Parameters

_params?

unknown

Returns

this

Inherited from

StringFormatBuilder.duration

---

e164()

e164(_params?): this;

Defined in: src/ZodBuilder/StringFormatBuilder.ts:148

Parameters

_params?

unknown

Returns

this

Inherited from

StringFormatBuilder.e164

---

endsWith()

endsWith(_value, _params?): this;

Defined in: src/ZodBuilder/StringFormatBuilder.ts:91

Parameters

_value

string

_params?

unknown

Returns

this

Implementation of

BuilderFor.endsWith

Inherited from

StringFormatBuilder.endsWith

---

format()

format(format, params?): this;

Defined in: src/ZodBuilder/StringFormatBuilder.ts:42

Apply format constraint.

Parameters

format

string

params?

unknown

Returns

this

Inherited from

StringFormatBuilder.format

---

guid()

guid(_params?): this;

Defined in: src/ZodBuilder/StringFormatBuilder.ts:139

Parameters

_params?

unknown

Returns

this

Inherited from

StringFormatBuilder.guid

---

hasConstraints()

hasConstraints(): boolean;

Defined in: src/ZodBuilder/StringFormatBuilder.ts:31

Check if this builder has any constraints applied.

Returns

boolean

Inherited from

StringFormatBuilder.hasConstraints

---

includes()

includes(_value, _params?): this;

Defined in: src/ZodBuilder/StringFormatBuilder.ts:85

Parameters

_value

string

_params?

unknown

Returns

this

Implementation of

BuilderFor.includes

Inherited from

StringFormatBuilder.includes

---

ip()

ip(_params?): this;

Defined in: src/ZodBuilder/StringFormatBuilder.ts:121

Parameters

_params?

unknown

Returns

this

Inherited from

StringFormatBuilder.ip

---

is()

is<K>(type): this is TypeKindOf<K>;

Defined in: src/ZodBuilder/BaseBuilder.ts:308

Type Parameters

K

K extends | "symbol" | "undefined" | "null" | "any" | "void" | "never" | "unknown" | "nan"

Parameters

type

K

Returns

this is TypeKindOf<K>

Inherited from

StringFormatBuilder.is

---

isV3()

protected isV3(): boolean;

Defined in: src/ZodBuilder/BaseBuilder.ts:158

Check if targeting Zod v3.

Returns

boolean

Inherited from

StringFormatBuilder.isV3

---

isV4()

protected isV4(): boolean;

Defined in: src/ZodBuilder/BaseBuilder.ts:151

Check if targeting Zod v4.

Returns

boolean

Inherited from

StringFormatBuilder.isV4

---

json()

json(params?): this;

Defined in: src/ZodBuilder/StringFormatBuilder.ts:73

Apply JSON transform.

Parameters

params?

unknown

Returns

this

Inherited from

StringFormatBuilder.json

---

ksuid()

ksuid(_params?): this;

Defined in: src/ZodBuilder/StringFormatBuilder.ts:145

Parameters

_params?

unknown

Returns

this

Inherited from

StringFormatBuilder.ksuid

---

length()

length(_len, _params?): this;

Defined in: src/ZodBuilder/StringFormatBuilder.ts:94

Parameters

_len

number

_params?

unknown

Returns

this

Implementation of

BuilderFor.length

Inherited from

StringFormatBuilder.length

---

lowercase()

lowercase(_params?): this;

Defined in: src/ZodBuilder/StringFormatBuilder.ts:100

Parameters

_params?

unknown

Returns

this

Implementation of

BuilderFor.lowercase

Inherited from

StringFormatBuilder.lowercase

---

max()

max(value, params?): this;

Defined in: src/ZodBuilder/StringFormatBuilder.ts:65

Apply maxLength constraint.

Parameters

value

number

params?

unknown

Returns

this

Implementation of

BuilderFor.max

Inherited from

StringFormatBuilder.max

---

meta()

meta(metadata): this;

Defined in: src/ZodBuilder/BaseBuilder.ts:277

Apply meta modifier.

Parameters

metadata

Record<string, unknown>

Returns

this

Implementation of

BuilderFor.meta

Inherited from

StringFormatBuilder.meta

---

min()

min(value, params?): this;

Defined in: src/ZodBuilder/StringFormatBuilder.ts:57

Apply minLength constraint.

Parameters

value

number

params?

unknown

Returns

this

Implementation of

BuilderFor.min

Inherited from

StringFormatBuilder.min

---

modify()

protected modify(baseText): string;

Defined in: src/ZodBuilder/BaseBuilder.ts:316

Apply all shared modifiers to the base schema string. This method is called by text() and applies modifiers in a stable order.

Parameters

baseText

string

Returns

string

Inherited from

StringFormatBuilder.modify

---

nonempty()

nonempty(_params?): this;

Defined in: src/ZodBuilder/StringFormatBuilder.ts:97

Parameters

_params?

unknown

Returns

this

Implementation of

BuilderFor.nonempty

Inherited from

StringFormatBuilder.nonempty

---

normalize()

normalize(_form?): this;

Defined in: src/ZodBuilder/StringFormatBuilder.ts:109

Parameters

_form?

string

Returns

this

Implementation of

BuilderFor.normalize

Inherited from

StringFormatBuilder.normalize

---

nullable()

nullable(): this;

Defined in: src/ZodBuilder/BaseBuilder.ts:204

Apply nullable constraint.

Returns

this

Implementation of

BuilderFor.nullable

Inherited from

StringFormatBuilder.nullable

---

optional()

optional(): this;

Defined in: src/ZodBuilder/BaseBuilder.ts:191

Apply optional constraint.

Returns

this

Implementation of

BuilderFor.optional

Inherited from

StringFormatBuilder.optional

---

pipe()

pipe(contentSchema, params?): this;

Defined in: src/ZodBuilder/StringFormatBuilder.ts:79

Apply pipe with parsed content schema.

Parameters

contentSchema

Builder

params?

unknown

Returns

this

Inherited from

StringFormatBuilder.pipe

---

readonly()

readonly(): this;

Defined in: src/ZodBuilder/BaseBuilder.ts:240

Apply readonly modifier.

Returns

this

Implementation of

BuilderFor.readonly

Inherited from

StringFormatBuilder.readonly

---

refine()

refine(refineFn, message?): this;

Defined in: src/ZodBuilder/BaseBuilder.ts:258

Apply refine modifier.

Note: function is provided as raw code string e.g. (val) => val > 0.

Parameters

refineFn

string

message?

string

Returns

this

Implementation of

BuilderFor.refine

Inherited from

StringFormatBuilder.refine

---

regex()

regex(pattern, params?): this;

Defined in: src/ZodBuilder/StringFormatBuilder.ts:48

Apply regex pattern constraint.

Parameters

pattern

string | RegExp

params?

unknown

Returns

this

Implementation of

BuilderFor.regex

Inherited from

StringFormatBuilder.regex

---

required()

required(): this;

Defined in: src/ZodBuilder/BaseBuilder.ts:196

Returns

this

Inherited from

StringFormatBuilder.required

---

safe()

safe(_params?): this;

Defined in: src/ZodBuilder/StringFormatBuilder.ts:124

Parameters

_params?

unknown

Returns

this

Inherited from

StringFormatBuilder.safe

---

serializeParams()

protected serializeParams(): string;

Defined in: src/ZodBuilder/BaseBuilder.ts:167

Serialize params to a string representation for code generation. Handles objects, strings, primitives, and undefined.

Returns

string

String representation of params or empty string if no params

Inherited from

StringFormatBuilder.serializeParams

---

slugify()

slugify(): this;

Defined in: src/ZodBuilder/StringFormatBuilder.ts:118

Returns

this

Implementation of

BuilderFor.slugify

Inherited from

StringFormatBuilder.slugify

---

startsWith()

startsWith(_value, _params?): this;

Defined in: src/ZodBuilder/StringFormatBuilder.ts:88

Parameters

_value

string

_params?

unknown

Returns

this

Implementation of

BuilderFor.startsWith

Inherited from

StringFormatBuilder.startsWith

---

superRefine()

superRefine(superRefineFn): this;

Defined in: src/ZodBuilder/BaseBuilder.ts:269

Apply superRefine modifier.

Note: function is provided as raw code string e.g. (val, ctx) => { ... }.

Parameters

superRefineFn

string

Returns

this

Implementation of

BuilderFor.superRefine

Inherited from

StringFormatBuilder.superRefine

---

text()

text(): string;

Defined in: src/ZodBuilder/BaseBuilder.ts:366

Unwrap and return the final Zod code string. This orchestrates the template method pattern: text() = modify(base())

Returns

string

Implementation of

BuilderFor.text

Inherited from

StringFormatBuilder.text

---

time()

time(_params?): this;

Defined in: src/ZodBuilder/StringFormatBuilder.ts:130

Parameters

_params?

unknown

Returns

this

Inherited from

StringFormatBuilder.time

---

toLowerCase()

toLowerCase(): this;

Defined in: src/ZodBuilder/StringFormatBuilder.ts:112

Returns

this

Implementation of

BuilderFor.toLowerCase

Inherited from

StringFormatBuilder.toLowerCase

---

toString()

toString(): string;

Defined in: src/ZodBuilder/BaseBuilder.ts:370

Returns a string representation of an object.

Returns

string

Inherited from

StringFormatBuilder.toString

---

toUpperCase()

toUpperCase(): this;

Defined in: src/ZodBuilder/StringFormatBuilder.ts:115

Returns

this

Implementation of

BuilderFor.toUpperCase

Inherited from

StringFormatBuilder.toUpperCase

---

transform()

transform(transformFn): this;

Defined in: src/ZodBuilder/BaseBuilder.ts:287

Apply transform modifier.

Note: function is provided as raw code string e.g. (val) => transformedVal.

Parameters

transformFn

string

Returns

this

Implementation of

BuilderFor.transform

Inherited from

StringFormatBuilder.transform

---

trim()

trim(): this;

Defined in: src/ZodBuilder/StringFormatBuilder.ts:106

Returns

this

Implementation of

BuilderFor.trim

Inherited from

StringFormatBuilder.trim

---

uppercase()

uppercase(_params?): this;

Defined in: src/ZodBuilder/StringFormatBuilder.ts:103

Parameters

_params?

unknown

Returns

this

Implementation of

BuilderFor.uppercase

Inherited from

StringFormatBuilder.uppercase

---

xid()

xid(_params?): this;

Defined in: src/ZodBuilder/StringFormatBuilder.ts:142

Parameters

_params?

unknown

Returns

this

Inherited from

StringFormatBuilder.xid