Function refine

Parameters

• fn: (arg: NoInfer<T>) => unknown
• Optional_params:
      | string
      | {
          abort?: boolean;
          when?: (payload: ParsePayload) => boolean;
          path?: PropertyKey[];
          params?: Record<string, any>;
          error?: string | $ZodErrorMap<NonNullable<$ZodIssue>>;
          message?: string;
      }
  • string
  • {
        abort?: boolean;
        when?: (payload: ParsePayload) => boolean;
        path?: PropertyKey[];
        params?: Record<string, any>;
        error?: string | $ZodErrorMap<NonNullable<$ZodIssue>>;
        message?: string;
    }

    • Optionalabort?: boolean

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

    • Optionalwhen?: (payload: ParsePayload) => boolean

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

    • Optionalpath?: PropertyKey[]

    • Optionalparams?: Record<string, any>

    • Optionalerror?: string | $ZodErrorMap<NonNullable<$ZodIssue>>

    • Optionalmessage?: string

      Deprecated

      This parameter is deprecated. Use error instead.