Node.js + Joi how to display a custom error messages?

by

Original answer:

The current way (I personally find it better) is to use .messages() (or .prefs({messages})).

const Joi = require('@hapi/joi');

const joiSchema = Joi.object({
  a: Joi.string()
    .min(2)
    .max(10)
    .required()
    .messages({
      'string.base': `"a" should be a type of 'text'`,
      'string.empty': `"a" cannot be an empty field`,
      'string.min': `"a" should have a minimum length of {#limit}`,
      'any.required': `"a" is a required field`
    })
});

const validationResult = joiSchema.validate({ a: 2 }, { abortEarly: false });
console.log(validationResult.error); // expecting ValidationError: "a" should be a type of 'text'

Usage of .errors() is not recommended just to update default message with custom message.

.prefs({ messages }) is an elaborate way to provide more options as preferences. The other options for prefs are taken directly from options of .validate()

Further read: https://github.com/hapijs/joi/issues/2158

Update 1: I saw that the above explanation did not work out for some folks, so I have put up some code to test yourself. Check it here: https://runkit.com/embed/fnfaq3j0z9l2

Also updated the code snippet shared previously to have details from package inclusion, to usage, to calling the actual validation method.

Update 2: The list of joi error types and their description (for .messages() – like string.base, array.unique, date.min etc..) is available here.

Update 3: Joi has moved from hapi project to standalone: https://www.npmjs.com/package/joi.
Make sure you are using latest version (or at least above v17).

More Related Contents:

  1. How to get GET (query string) variables in Express.js on Node.js?
  2. req.body empty on posts
  3. Check synchronously if file/directory exists in Node.js
  4. The difference between “require(x)” and “import x”
  5. nvm keeps “forgetting” node in new terminal session
  6. Express.js – app.listen vs server.listen
  7. Node.js: printing to console without a trailing newline?
  8. How can I change the version of npm using nvm?
  9. How to install node.js as windows service?
  10. Node.js Hostname/IP doesn’t match certificate’s altnames
  11. How to solve npm install throwing fsevents warning on non-MAC OS?
  12. Express JS use async function on requests
  13. Any way to force strict mode in node?
  14. `npm install` fails on node-gyp rebuild with `gyp: No Xcode or CLT version detected!`
  15. NPM doesn’t install any modules: network socket hangs up
  16. bcrypt invalid elf header when running node app
  17. Module not found: Can’t resolve ‘fs’ in Next.js application
  18. Why use peer dependencies in npm for plugins?
  19. Having a hard time trying to understand ‘next/next()’ in express.js
  20. Stop node.js program from command line
  21. How do I fix a vulnerable npm package in my package-lock.json that isn’t listed in the package.json?
  22. Error: “The operation was rejected by your operating system” when trying to create new angular project using windows powershell
  23. Fail to connect Mongoose to Atlas
  24. Node.js: How to attach to a running process and to debug the server with a console?
  25. npm doesn’t work, get always this error -> Error: Cannot find module ‘are-we-there-yet’
  26. Node.js server with multiple concurrent requests, how does it work?
  27. Heroku app crashes after MongoDB updated to 3.0
  28. ESLint error while trying to deploy firebase functions
  29. Express.js Routing error: Can’t set headers after they are sent
  30. body-parser – extended option (qs vs querystring)

Leave a Comment