Incorrect documentation of validate()

[alxtsg]

Context

• node version: 10.16.3
• joi version: 16.1.4
• environment (node, browser): node
• used with (hapi, standalone, ...): standalone
• any other relevant information:

What are you trying to achieve or the steps to reproduce ?

I am using a schema to validate some data.

'use strict';

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

const schema = joi.object({
  name: joi.string().required(),
});

const data = {
  name: 'Alex',
};

const result = schema.validate(data);
if (result.error === null) {
  console.log('OK.');
} else {
  console.error(result.error);
}

According to the document:

If the input is valid, then the error will be null.

However, in the v16.0.0 Release Notes:

Change error in sync validate() result to undefined instead of null when there is no error (#2036).

The document is incorrect. The document should say:

If the input is valid, then the error will be undefined.

Which result you had ?

The console prints undefined.

What did you expect ?

The console should print OK.

[hueniverse]

Thanks. In the future, a quick PR would have been less for for both of us.

[lock]

This thread has been automatically locked due to inactivity. Please open a new issue for related bugs or questions following the new issue template instructions.