errors.d.ts 1.6 KB

123456789101112131415161718192021222324252627282930
  1. import * as core from "../core/index.js";
  2. import { $ZodError } from "../core/index.js";
  3. /** @deprecated Use `z.core.$ZodIssue` from `@zod/core` instead, especially if you are building a library on top of Zod. */
  4. export type ZodIssue = core.$ZodIssue;
  5. /** An Error-like class used to store Zod validation issues. */
  6. export interface ZodError<T = unknown> extends $ZodError<T> {
  7. /** @deprecated Use the `z.treeifyError(err)` function instead. */
  8. format(): core.$ZodFormattedError<T>;
  9. format<U>(mapper: (issue: core.$ZodIssue) => U): core.$ZodFormattedError<T, U>;
  10. /** @deprecated Use the `z.treeifyError(err)` function instead. */
  11. flatten(): core.$ZodFlattenedError<T>;
  12. flatten<U>(mapper: (issue: core.$ZodIssue) => U): core.$ZodFlattenedError<T, U>;
  13. /** @deprecated Push directly to `.issues` instead. */
  14. addIssue(issue: core.$ZodIssue): void;
  15. /** @deprecated Push directly to `.issues` instead. */
  16. addIssues(issues: core.$ZodIssue[]): void;
  17. /** @deprecated Check `err.issues.length === 0` instead. */
  18. isEmpty: boolean;
  19. }
  20. export declare const ZodError: core.$constructor<ZodError>;
  21. export declare const ZodRealError: core.$constructor<ZodError>;
  22. export type {
  23. /** @deprecated Use `z.core.$ZodFlattenedError` instead. */
  24. $ZodFlattenedError as ZodFlattenedError,
  25. /** @deprecated Use `z.core.$ZodFormattedError` instead. */
  26. $ZodFormattedError as ZodFormattedError,
  27. /** @deprecated Use `z.core.$ZodErrorMap` instead. */
  28. $ZodErrorMap as ZodErrorMap, } from "../core/index.js";
  29. /** @deprecated Use `z.core.$ZodRawIssue` instead. */
  30. export type IssueData = core.$ZodRawIssue;