@morojs/moro / z / ZodBase64

Interface: ZodBase64

Defined in: node_modules/zod/v4/classic/schemas.d.cts:241

Extends

ZodStringFormat<"base64">

Properties

_def

_def: $ZodStringFormatDef<"base64">

Defined in: node_modules/zod/v4/classic/schemas.d.cts:8

Deprecated

Use .def instead.

Inherited from

ZodStringFormat._def

_input

_input: string

Defined in: node_modules/zod/v4/classic/schemas.d.cts:12

Deprecated

Use z.input<typeof schema> instead.

Inherited from

ZodStringFormat._input

_output

_output: string

Defined in: node_modules/zod/v4/classic/schemas.d.cts:10

Deprecated

Use z.output<typeof schema> instead.

Inherited from

ZodStringFormat._output

_zod

_zod: $ZodBase64Internals

Defined in: node_modules/zod/v4/classic/schemas.d.cts:242

Overrides

ZodStringFormat._zod

~standard

~standard: $ZodStandardSchema<ZodBase64>

Defined in: node_modules/zod/v4/core/schemas.d.cts:90

Inherited from

ZodStringFormat.~standard

def

def: $ZodStringFormatDef<"base64">

Defined in: node_modules/zod/v4/classic/schemas.d.cts:5

Inherited from

ZodStringFormat.def

description?

optional description: string

Defined in: node_modules/zod/v4/classic/schemas.d.cts:53

Inherited from

ZodStringFormat.description

format

format: null | string

Defined in: node_modules/zod/v4/classic/schemas.d.cts:80

Inherited from

ZodStringFormat.format

maxLength

maxLength: null | number

Defined in: node_modules/zod/v4/classic/schemas.d.cts:82

Inherited from

ZodStringFormat.maxLength

minLength

minLength: null | number

Defined in: node_modules/zod/v4/classic/schemas.d.cts:81

Inherited from

ZodStringFormat.minLength

spa()

spa: (data, params?) => Promise<ZodSafeParseResult<string>>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:23

Parameters

data

unknown

params?

ParseContext<$ZodIssue>

Returns

Promise<ZodSafeParseResult<string>>

Inherited from

ZodStringFormat.spa

type

type: "string"

Defined in: node_modules/zod/v4/classic/schemas.d.cts:6

Inherited from

ZodStringFormat.type

Methods

and()

and<T>(incoming): ZodIntersection<ZodBase64, T>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:45

Type Parameters

T

T extends SomeType

Parameters

incoming

T

Returns

ZodIntersection<ZodBase64, T>

Inherited from

ZodStringFormat.and

array()

array(): ZodArray<ZodBase64>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:43

Returns

ZodArray<ZodBase64>

Inherited from

ZodStringFormat.array

brand()

brand<T>(value?): PropertyKey extends T ? ZodBase64 : $ZodBranded<ZodBase64, T>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:18

Type Parameters

T

T extends PropertyKey = PropertyKey

Parameters

value?

T

Returns

PropertyKey extends T ? ZodBase64 : $ZodBranded<ZodBase64, T>

Inherited from

ZodStringFormat.brand

catch()

Call Signature

catch(def): ZodCatch<ZodBase64>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:47

Parameters

def

string

Returns

ZodCatch<ZodBase64>

Inherited from

ZodStringFormat.catch

Call Signature

catch(def): ZodCatch<ZodBase64>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:48

Parameters

def

(ctx) => string

Returns

ZodCatch<ZodBase64>

Inherited from

ZodStringFormat.catch

check()

check(...checks): this

Defined in: node_modules/zod/v4/classic/schemas.d.cts:13

Parameters

checks

...($ZodCheck<string> | CheckFn<string>)[]

Returns

this

Inherited from

ZodStringFormat.check

clone()

clone(def?, params?): this

Defined in: node_modules/zod/v4/classic/schemas.d.cts:14

Parameters

def?

$ZodStringFormatDef<"base64">

params?

parent

boolean

Returns

this

Inherited from

ZodStringFormat.clone

decode()

decode(data, params?): string

Defined in: node_modules/zod/v4/classic/schemas.d.cts:25

Parameters

data

string

params?

ParseContext<$ZodIssue>

Returns

string

Inherited from

ZodStringFormat.decode

decodeAsync()

decodeAsync(data, params?): Promise<string>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:27

Parameters

data

string

params?

ParseContext<$ZodIssue>

Returns

Promise<string>

Inherited from

ZodStringFormat.decodeAsync

default()

Call Signature

default(def): ZodDefault<ZodBase64>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:39

Parameters

def

string

Returns

ZodDefault<ZodBase64>

Inherited from

ZodStringFormat.default

Call Signature

default(def): ZodDefault<ZodBase64>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:40

Parameters

def

() => string

Returns

ZodDefault<ZodBase64>

Inherited from

ZodStringFormat.default

describe()

describe(description): this

Defined in: node_modules/zod/v4/classic/schemas.d.cts:52

Returns a new instance that has been registered in z.globalRegistry with the specified description

Parameters

description

string

Returns

this

Inherited from

ZodStringFormat.describe

encode()

encode(data, params?): string

Defined in: node_modules/zod/v4/classic/schemas.d.cts:24

Parameters

data

string

params?

ParseContext<$ZodIssue>

Returns

string

Inherited from

ZodStringFormat.encode

encodeAsync()

encodeAsync(data, params?): Promise<string>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:26

Parameters

data

string

params?

ParseContext<$ZodIssue>

Returns

Promise<string>

Inherited from

ZodStringFormat.encodeAsync

endsWith()

endsWith(value, params?): this

Defined in: node_modules/zod/v4/classic/schemas.d.cts:86

Parameters

value

string

params?

string |

{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>; message?: string; }

abort?

boolean

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

error?

string | $ZodErrorMap<$ZodIssueInvalidStringFormat>

message?

string

Deprecated

This parameter is deprecated. Use error instead.

Returns

this

Inherited from

ZodStringFormat.endsWith

includes()

includes(value, params?): this

Defined in: node_modules/zod/v4/classic/schemas.d.cts:84

Parameters

value

string

params?

abort?

boolean

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

error?

string | $ZodErrorMap<$ZodIssueInvalidStringFormat>

message?

string

Deprecated

This parameter is deprecated. Use error instead.

position?

number

Returns

this

Inherited from

ZodStringFormat.includes

isNullable()

isNullable(): boolean

Defined in: node_modules/zod/v4/classic/schemas.d.cts:74

Returns

boolean

Deprecated

Try safe-parsing null (this is what isNullable does internally):

const schema = z.string().nullable();
const isNullable = schema.safeParse(null).success; // true

Inherited from

ZodStringFormat.isNullable

isOptional()

isOptional(): boolean

Defined in: node_modules/zod/v4/classic/schemas.d.cts:65

Returns

boolean

Deprecated

Try safe-parsing undefined (this is what isOptional does internally):

const schema = z.string().optional();
const isOptional = schema.safeParse(undefined).success; // true

Inherited from

ZodStringFormat.isOptional

length()

length(len, params?): this

Defined in: node_modules/zod/v4/classic/schemas.d.cts:89

Parameters

len

number

params?

string |

{ abort?: boolean; error?: string | $ZodErrorMap<NonNullable<$ZodIssueTooSmall<HasLength> | $ZodIssueTooBig<HasLength>>>; message?: string; }

abort?

boolean

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

error?

string | $ZodErrorMap<NonNullable<$ZodIssueTooSmall<HasLength> | $ZodIssueTooBig<HasLength>>>

message?

string

Deprecated

This parameter is deprecated. Use error instead.

Returns

this

Inherited from

ZodStringFormat.length

lowercase()

lowercase(params?): this

Defined in: node_modules/zod/v4/classic/schemas.d.cts:91

Parameters

params?

string |

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

abort?

boolean

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

error?

string | $ZodErrorMap<$ZodIssueInvalidStringFormat>

message?

string

Deprecated

This parameter is deprecated. Use error instead.

pattern?

RegExp

Returns

this

Inherited from

ZodStringFormat.lowercase

max()

max(maxLength, params?): this

Defined in: node_modules/zod/v4/classic/schemas.d.cts:88

Parameters

maxLength

number

params?

string |

{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueTooBig<HasLength>>; message?: string; }

abort?

boolean

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

error?

string | $ZodErrorMap<$ZodIssueTooBig<HasLength>>

message?

string

Deprecated

This parameter is deprecated. Use error instead.

Returns

this

Inherited from

ZodStringFormat.max

meta()

Call Signature

meta(): undefined | {[key: string]: unknown; deprecated?: boolean; description?: string; id?: string; title?: string; }

Defined in: node_modules/zod/v4/classic/schemas.d.cts:55

Returns the metadata associated with this instance in z.globalRegistry

Returns

undefined | {[key: string]: unknown; deprecated?: boolean; description?: string; id?: string; title?: string; }

Inherited from

ZodStringFormat.meta

Call Signature

meta(data): this

Defined in: node_modules/zod/v4/classic/schemas.d.cts:57

Returns a new instance that has been registered in z.globalRegistry with the specified metadata

Parameters

data

deprecated?

boolean

description?

string

id?

string

title?

string

Returns

this

Inherited from

ZodStringFormat.meta

min()

min(minLength, params?): this

Defined in: node_modules/zod/v4/classic/schemas.d.cts:87

Parameters

minLength

number

params?

string |

{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueTooSmall<HasLength>>; message?: string; }

abort?

boolean

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

error?

string | $ZodErrorMap<$ZodIssueTooSmall<HasLength>>

message?

string

Deprecated

This parameter is deprecated. Use error instead.

Returns

this

Inherited from

ZodStringFormat.min

nonempty()

nonempty(params?): this

Defined in: node_modules/zod/v4/classic/schemas.d.cts:90

Parameters

params?

string |

{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueTooSmall<HasLength>>; message?: string; }

abort?

boolean

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

error?

string | $ZodErrorMap<$ZodIssueTooSmall<HasLength>>

message?

string

Deprecated

This parameter is deprecated. Use error instead.

Returns

this

Inherited from

ZodStringFormat.nonempty

nonoptional()

nonoptional(params?): ZodNonOptional<ZodBase64>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:36

Parameters

params?

string |

{ error?: string | $ZodErrorMap<$ZodIssueInvalidType<unknown>>; message?: string; }

error?

string | $ZodErrorMap<$ZodIssueInvalidType<unknown>>

message?

string

Deprecated

This parameter is deprecated. Use error instead.

Returns

ZodNonOptional<ZodBase64>

Inherited from

ZodStringFormat.nonoptional

normalize()

normalize(form?): this

Defined in: node_modules/zod/v4/classic/schemas.d.cts:94

Parameters

form?

string & object | "NFC" | "NFD" | "NFKC" | "NFKD"

Returns

this

Inherited from

ZodStringFormat.normalize

nullable()

nullable(): ZodNullable<ZodBase64>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:37

Returns

ZodNullable<ZodBase64>

Inherited from

ZodStringFormat.nullable

nullish()

nullish(): ZodOptional<ZodNullable<ZodBase64>>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:38

Returns

ZodOptional<ZodNullable<ZodBase64>>

Inherited from

ZodStringFormat.nullish

optional()

optional(): ZodOptional<ZodBase64>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:35

Returns

ZodOptional<ZodBase64>

Inherited from

ZodStringFormat.optional

or()

or<T>(option): ZodUnion<[ZodBase64, T]>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:44

Type Parameters

T

T extends SomeType

Parameters

option

T

Returns

ZodUnion<[ZodBase64, T]>

Inherited from

ZodStringFormat.or

overwrite()

overwrite(fn): this

Defined in: node_modules/zod/v4/classic/schemas.d.cts:34

Parameters

fn

(x) => string

Returns

this

Inherited from

ZodStringFormat.overwrite

parse()

parse(data, params?): string

Defined in: node_modules/zod/v4/classic/schemas.d.cts:19

Parameters

data

unknown

params?

ParseContext<$ZodIssue>

Returns

string

Inherited from

ZodStringFormat.parse

parseAsync()

parseAsync(data, params?): Promise<string>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:21

Parameters

data

unknown

params?

ParseContext<$ZodIssue>

Returns

Promise<string>

Inherited from

ZodStringFormat.parseAsync

pipe()

pipe<T>(target): ZodPipe<ZodBase64, T>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:49

Type Parameters

T

T extends $ZodType<any, string, $ZodTypeInternals<any, string>>

Parameters

target

$ZodType<any, string, $ZodTypeInternals<any, string>> | T

Returns

ZodPipe<ZodBase64, T>

Inherited from

ZodStringFormat.pipe

prefault()

Call Signature

prefault(def): ZodPrefault<ZodBase64>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:41

Parameters

def

() => string

Returns

ZodPrefault<ZodBase64>

Inherited from

ZodStringFormat.prefault

Call Signature

prefault(def): ZodPrefault<ZodBase64>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:42

Parameters

def

string

Returns

ZodPrefault<ZodBase64>

Inherited from

ZodStringFormat.prefault

readonly()

readonly(): ZodReadonly<ZodBase64>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:50

Returns

ZodReadonly<ZodBase64>

Inherited from

ZodStringFormat.readonly

refine()

refine(check, params?): this

Defined in: node_modules/zod/v4/classic/schemas.d.cts:32

Parameters

check

(arg) => unknown

params?

string |

{ abort?: boolean; error?: string | $ZodErrorMap<NonNullable<$ZodIssue>>; message?: string; params?: Record<string, any>; path?: PropertyKey[]; when?: (payload) => boolean; }

abort?

boolean

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

error?

string | $ZodErrorMap<NonNullable<$ZodIssue>>

message?

string

Deprecated

This parameter is deprecated. Use error instead.

params?

Record<string, any>

path?

PropertyKey[]

when?

(payload) => boolean

If provided, this check will only be executed if the function returns true. Defaults to payload => z.util.isAborted(payload).

Returns

this

Inherited from

ZodStringFormat.refine

regex()

regex(regex, params?): this

Defined in: node_modules/zod/v4/classic/schemas.d.cts:83

Parameters

regex

RegExp

params?

string |

{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>; message?: string; }

abort?

boolean

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

error?

string | $ZodErrorMap<$ZodIssueInvalidStringFormat>

message?

string

Deprecated

This parameter is deprecated. Use error instead.

Returns

this

Inherited from

ZodStringFormat.regex

register()

register<R>(registry, ...meta): this

Defined in: node_modules/zod/v4/classic/schemas.d.cts:17

Type Parameters

R

R extends $ZodRegistry<MetadataType, $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>>

Parameters

registry

R

Returns

this

Inherited from

ZodStringFormat.register

safeDecode()

safeDecode(data, params?): ZodSafeParseResult<string>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:29

Parameters

data

string

safeDecodeAsync()

safeDecodeAsync(data, params?): Promise<ZodSafeParseResult<string>>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:31

Parameters

data

string

params?

ParseContext<$ZodIssue>

Returns

Promise<ZodSafeParseResult<string>>

Inherited from

ZodStringFormat.safeDecodeAsync

safeEncode()

safeEncode(data, params?): ZodSafeParseResult<string>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:28

Parameters

data

string

params?

ParseContext<$ZodIssue>

Returns

ZodSafeParseResult<string>

Inherited from

ZodStringFormat.safeEncode

safeEncodeAsync()

safeEncodeAsync(data, params?): Promise<ZodSafeParseResult<string>>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:30

Parameters

data

string

params?

ParseContext<$ZodIssue>

Returns

Promise<ZodSafeParseResult<string>>

Inherited from

ZodStringFormat.safeEncodeAsync

safeParse()

safeParse(data, params?): ZodSafeParseResult<string>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:20

Parameters

data

unknown

params?

ParseContext<$ZodIssue>

Returns

ZodSafeParseResult<string>

Inherited from

ZodStringFormat.safeParse

safeParseAsync()

safeParseAsync(data, params?): Promise<ZodSafeParseResult<string>>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:22

Parameters

data

unknown

params?

ParseContext<$ZodIssue>

Returns

Promise<ZodSafeParseResult<string>>

Inherited from

ZodStringFormat.safeParseAsync

startsWith()

startsWith(value, params?): this

Defined in: node_modules/zod/v4/classic/schemas.d.cts:85

Parameters

value

string

params?

string |

{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>; message?: string; }

abort?

boolean

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

error?

string | $ZodErrorMap<$ZodIssueInvalidStringFormat>

message?

string

Deprecated

This parameter is deprecated. Use error instead.

Returns

this

Inherited from

ZodStringFormat.startsWith

superRefine()

superRefine(refinement): this

Defined in: node_modules/zod/v4/classic/schemas.d.cts:33

Parameters

refinement

(arg, ctx) => void | Promise<void>

Returns

this

Inherited from

ZodStringFormat.superRefine

toLowerCase()

toLowerCase(): this

Defined in: node_modules/zod/v4/classic/schemas.d.cts:95

Returns

this

Inherited from

ZodStringFormat.toLowerCase

toUpperCase()

toUpperCase(): this

Defined in: node_modules/zod/v4/classic/schemas.d.cts:96

Returns

this

Inherited from

ZodStringFormat.toUpperCase

transform()

transform<NewOut>(transform): ZodPipe<ZodBase64, ZodTransform<Awaited<NewOut>, string>>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:46

Type Parameters

NewOut

NewOut

Parameters

transform

(arg, ctx) => NewOut | Promise<NewOut>

Returns

ZodPipe<ZodBase64, ZodTransform<Awaited<NewOut>, string>>

Inherited from

ZodStringFormat.transform

trim()

trim(): this

Defined in: node_modules/zod/v4/classic/schemas.d.cts:93

Returns

this

Inherited from

ZodStringFormat.trim

uppercase()

uppercase(params?): this

Defined in: node_modules/zod/v4/classic/schemas.d.cts:92

Parameters

params?

string |

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

abort?

boolean

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

error?

string | $ZodErrorMap<$ZodIssueInvalidStringFormat>

message?

string

Deprecated

This parameter is deprecated. Use error instead.

pattern?

RegExp

Returns

this

Inherited from

ZodStringFormat.uppercase

Interface: ZodBase64

Extends

Properties

~~_def~~

Deprecated

Inherited from

~~_input~~

Deprecated

Inherited from

~~_output~~

Deprecated

Inherited from

_zod

Overrides

~standard

Inherited from

def

Inherited from

description?

Inherited from

format

Inherited from

maxLength

Inherited from

minLength

Inherited from

spa()

Parameters

data

params?

Returns

Inherited from

type

Inherited from

Methods

and()

Type Parameters

T

Parameters

incoming

Returns

Inherited from

array()

Returns

Inherited from

brand()

Type Parameters

T

Parameters

value?

Returns

Inherited from

catch()

Call Signature

Parameters

def

Returns

Inherited from

Call Signature

Parameters

def

Returns

Inherited from

check()

Parameters

checks

Returns

Inherited from

clone()

Parameters

def?

params?

parent

Returns

Inherited from

decode()

Parameters

data

params?

Returns

_def

_input

_output

isNullable()

isOptional()