@morojs/moro

@morojs/moro / z / ZodPipe

Interface: ZodPipe<A, B>

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

Extends

• _ZodType<$ZodPipeInternals<A, B>>.$ZodPipe<A, B>

Extended by

• ZodCodec

Type Parameters

A

A extends SomeType = $ZodType

B

B extends SomeType = $ZodType

Properties

~~_def~~

_def: $ZodPipeDef<A, B>

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

Deprecated

Use .def instead.

Inherited from

_ZodType._def

~~_input~~

_input: input<A>

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

Deprecated

Use z.input<typeof schema> instead.

Inherited from

_ZodType._input

~~_output~~

_output: output<B>

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

Deprecated

Use z.output<typeof schema> instead.

Inherited from

_ZodType._output

_zod

_zod: $ZodPipeInternals

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

Inherited from

_ZodType._zod

~standard

~standard: $ZodStandardSchema<ZodPipe<A, B>>

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

Inherited from

_ZodType.~standard

def

def: $ZodPipeDef<A, B>

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

Inherited from

_ZodType.def

description?

optional description: string

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

Inherited from

_ZodType.description

in

in: A

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

out

out: B

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

spa()

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

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

Parameters

data

unknown

params?

ParseContext<$ZodIssue>

Returns

Promise<ZodSafeParseResult<output<B>>>

Inherited from

_ZodType.spa

type

type: "pipe"

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

Inherited from

_ZodType.type

Methods

and()

and<T>(incoming): ZodIntersection<ZodPipe<A, B>, T>

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

Type Parameters

T

T extends SomeType

Parameters

incoming

T

Returns

ZodIntersection<ZodPipe<A, B>, T>

Inherited from

_ZodType.and

array()

array(): ZodArray<ZodPipe<A, B>>

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

Returns

ZodArray<ZodPipe<A, B>>

Inherited from

_ZodType.array

brand()

brand<T>(value?): PropertyKey extends T ? ZodPipe<A, B> : $ZodBranded<ZodPipe<A, B>, 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 ? ZodPipe<A, B> : $ZodBranded<ZodPipe<A, B>, T>

Inherited from

_ZodType.brand

catch()

Call Signature

catch(def): ZodCatch<ZodPipe<A, B>>

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

Parameters

def

output<B>

Returns

ZodCatch<ZodPipe<A, B>>

Inherited from

_ZodType.catch

Call Signature

catch(def): ZodCatch<ZodPipe<A, B>>

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

Parameters

def

(ctx) => output<B>

Returns

ZodCatch<ZodPipe<A, B>>

Inherited from

_ZodType.catch

check()

check(...checks): this

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

Parameters

checks

...(CheckFn<output<B>> | $ZodCheck<output<B>>)[]

Returns

this

Inherited from

_ZodType.check

clone()

clone(def?, params?): this

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

Parameters

def?

$ZodPipeDef<A, B>

params?

parent

boolean

Returns

this

Inherited from

_ZodType.clone

decode()

decode(data, params?): output<B>

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

Parameters

data

input<A>

params?

ParseContext<$ZodIssue>

Returns

output<B>

Inherited from

_ZodType.decode

decodeAsync()

decodeAsync(data, params?): Promise<output<B>>

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

Parameters

data

input<A>

params?

ParseContext<$ZodIssue>

Returns

Promise<output<B>>

Inherited from

_ZodType.decodeAsync

default()

Call Signature

default(def): ZodDefault<ZodPipe<A, B>>

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

Parameters

def

output<B>

Returns

ZodDefault<ZodPipe<A, B>>

Inherited from

_ZodType.default

Call Signature

default(def): ZodDefault<ZodPipe<A, B>>

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

Parameters

def

() => NoUndefined<output<B>>

Returns

ZodDefault<ZodPipe<A, B>>

Inherited from

_ZodType.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

_ZodType.describe

encode()

encode(data, params?): input<A>

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

Parameters

data

output<B>

params?

ParseContext<$ZodIssue>

Returns

input<A>

Inherited from

_ZodType.encode

encodeAsync()

encodeAsync(data, params?): Promise<input<A>>

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

Parameters

data

output<B>

params?

ParseContext<$ZodIssue>

Returns

Promise<input<A>>

Inherited from

_ZodType.encodeAsync

~~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

_ZodType.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

_ZodType.isOptional

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

_ZodType.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

_ZodType.meta

nonoptional()

nonoptional(params?): ZodNonOptional<ZodPipe<A, B>>

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<ZodPipe<A, B>>

Inherited from

_ZodType.nonoptional

nullable()

nullable(): ZodNullable<ZodPipe<A, B>>

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

Returns

ZodNullable<ZodPipe<A, B>>

Inherited from

_ZodType.nullable

nullish()

nullish(): ZodOptional<ZodNullable<ZodPipe<A, B>>>

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

Returns

ZodOptional<ZodNullable<ZodPipe<A, B>>>

Inherited from

_ZodType.nullish

optional()

optional(): ZodOptional<ZodPipe<A, B>>

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

Returns

ZodOptional<ZodPipe<A, B>>

Inherited from

_ZodType.optional

or()

or<T>(option): ZodUnion<[ZodPipe<A, B>, T]>

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

Type Parameters

T

T extends SomeType

Parameters

option

T

Returns

ZodUnion<[ZodPipe<A, B>, T]>

Inherited from

_ZodType.or

overwrite()

overwrite(fn): this

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

Parameters

fn

(x) => output<B>

Returns

this

Inherited from

_ZodType.overwrite

parse()

parse(data, params?): output<B>

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

Parameters

data

unknown

params?

ParseContext<$ZodIssue>

Returns

output<B>

Inherited from

_ZodType.parse

parseAsync()

parseAsync(data, params?): Promise<output<B>>

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

Parameters

data

unknown

params?

ParseContext<$ZodIssue>

Returns

Promise<output<B>>

Inherited from

_ZodType.parseAsync

pipe()

pipe<T>(target): ZodPipe<ZodPipe<A, B>, T>

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

Type Parameters

T

T extends $ZodType<any, output<B>, $ZodTypeInternals<any, output<B>>>

Parameters

target

T | $ZodType<any, output<B>, $ZodTypeInternals<any, output<B>>>

Returns

ZodPipe<ZodPipe<A, B>, T>

Inherited from

_ZodType.pipe

prefault()

Call Signature

prefault(def): ZodPrefault<ZodPipe<A, B>>

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

Parameters

def

() => input<A>

Returns

ZodPrefault<ZodPipe<A, B>>

Inherited from

_ZodType.prefault

Call Signature

prefault(def): ZodPrefault<ZodPipe<A, B>>

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

Parameters

def

input<A>

Returns

ZodPrefault<ZodPipe<A, B>>

Inherited from

_ZodType.prefault

readonly()

readonly(): ZodReadonly<ZodPipe<A, B>>

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

Returns

ZodReadonly<ZodPipe<A, B>>

Inherited from

_ZodType.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

_ZodType.refine

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

meta

...ZodPipe<A, B> extends R["_schema"] ? undefined extends R["_meta"] ? [$replace<R["_meta"], R["_schema"] & ZodPipe<A, B>>?] : [$replace<R["_meta"], R["_schema"] & ZodPipe<A, B>>] : ["Incompatible schema"]

Returns

this

Inherited from

_ZodType.register

safeDecode()

safeDecode(data, params?): ZodSafeParseResult<output<B>>

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

Parameters

data

input<A>

params?

ParseContext<$ZodIssue>

Returns

ZodSafeParseResult<output<B>>

Inherited from

_ZodType.safeDecode

safeDecodeAsync()

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

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

Parameters

data

input<A>

params?

ParseContext<$ZodIssue>

Returns

Promise<ZodSafeParseResult<output<B>>>

Inherited from

_ZodType.safeDecodeAsync

safeEncode()

safeEncode(data, params?): ZodSafeParseResult<input<A>>

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

Parameters

data

output<B>

params?

ParseContext<$ZodIssue>

Returns

ZodSafeParseResult<input<A>>

Inherited from

_ZodType.safeEncode

safeEncodeAsync()

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

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

Parameters

data

output<B>

params?

ParseContext<$ZodIssue>

Returns

Promise<ZodSafeParseResult<input<A>>>

Inherited from

_ZodType.safeEncodeAsync

safeParse()

safeParse(data, params?): ZodSafeParseResult<output<B>>

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

Parameters

data

unknown

params?

ParseContext<$ZodIssue>

Returns

ZodSafeParseResult<output<B>>

Inherited from

_ZodType.safeParse

safeParseAsync()

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

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

Parameters

data

unknown

params?

ParseContext<$ZodIssue>

Returns

Promise<ZodSafeParseResult<output<B>>>

Inherited from

_ZodType.safeParseAsync

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

_ZodType.superRefine

transform()

transform<NewOut>(transform): ZodPipe<ZodPipe<A, B>, ZodTransform<Awaited<NewOut>, output<B>>>

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

Type Parameters

NewOut

NewOut

Parameters

transform

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

Returns

ZodPipe<ZodPipe<A, B>, ZodTransform<Awaited<NewOut>, output<B>>>

Inherited from

_ZodType.transform