zod-error-utils

A set of utilities to work with Zod errors.

[!IMPORTANT] This package is not recommended to use for Zod V4, as it has better support for error messages and paths. See the Zod V4 documentation for more information.

📦 Installation

npm install zod-error-utils

🚀 Usage

import { buildZodErrorMap, flattenErrorPath, zodErrorMap } from "zod-error-utils";

const schema = z.object({
  user: z.object({
    name: z.string(),
    isAdministrator: z.boolean(),
  }),
});

const data = {
  user: {
    name: "John Doe",
    isAdministrator: true,
  },
};

const result = schema.safeParse(data, {
  errorMap: zodErrorMap
});

// you can customize the zodErrorMap, by creating a new one using `buildZodErrorMap`.

const customErrorMap = buildZodErrorMap({
  prefixFn(path, message) {
    return `Custom prefix: ${path.join(".")}: ${message}`;
  },
});

📄 License

Published under MIT License.