Class ZodFunction<Args, Returns>

Type Parameters

Hierarchy

Constructors

  • Type Parameters

    Type Parameters

    • Args extends ZodTuple<any, any, Args>

    • Returns extends ZodType<any, any, any, Returns>

    Parameters

    Returns ZodFunction<Args, Returns>

Properties

_def: ZodFunctionDef<Args, Returns>
_input: InnerTypeOfFunction<Args, Returns>
_output: OuterTypeOfFunction<Args, Returns>
_type: OuterTypeOfFunction<Args, Returns>
spa: ((data: unknown, params?: Partial<ParseParams>) => Promise<SafeParseReturnType<InnerTypeOfFunction<Args, Returns>, OuterTypeOfFunction<Args, Returns>>>)

Type declaration

superRefine: ((refinement: ((arg: OuterTypeOfFunction<Args, Returns>, ctx: RefinementCtx) => any)) => ZodEffects<ZodFunction<Args, Returns>, OuterTypeOfFunction<Args, Returns>, InnerTypeOfFunction<Args, Returns>>)

Type declaration

validate: (<F>(func: F) => ReturnType<F> extends Returns["_output"] ? ((...args: Args["_input"]) => ReturnType<F>) : OuterTypeOfFunction<Args, Returns>)

Type declaration

    • <F>(func: F): ReturnType<F> extends Returns["_output"] ? ((...args: Args["_input"]) => ReturnType<F>) : OuterTypeOfFunction<Args, Returns>
    • Type Parameters

      Type Parameters

      • F extends ((...args: any[any]) => Returns["_input"])

      Parameters

      • func: F

      Returns ReturnType<F> extends Returns["_output"] ? ((...args: Args["_input"]) => ReturnType<F>) : OuterTypeOfFunction<Args, Returns>

Accessors

  • get description(): undefined | string
  • Returns undefined | string

Methods

  • Parameters

    Returns string

  • Type Parameters

    Type Parameters

    • B extends string | number | symbol

    Returns ZodBranded<ZodFunction<Args, Returns>, B>

  • Parameters

    • description: string

    Returns ZodFunction<Args, Returns>

  • Type Parameters

    Type Parameters

    • F extends ((...args: any[any]) => Returns["_input"])

    Parameters

    • func: F

    Returns ReturnType<F> extends Returns["_output"] ? ((...args: Args["_input"]) => ReturnType<F>) : OuterTypeOfFunction<Args, Returns>

  • Returns boolean

  • Returns boolean

  • Type Parameters

    Type Parameters

    • T extends ZodType<any, any, any, T>

    Parameters

    • option: T

    Returns ZodUnion<[ZodFunction<Args, Returns>, T]>

  • Returns Args

  • Returns Returns

  • Type Parameters

    Type Parameters

    • NewReturnType extends ZodType<any, any, any, NewReturnType>

    Parameters

    • returnType: NewReturnType

    Returns ZodFunction<Args, NewReturnType>

Generated using TypeDoc