Documentation: resolver should return a Promise

[Satyam]

In API, the description for the resolver says that it should be a function returning an object with values and errors properties but it actually expects a Promise returning such an object.

If a resolver returns an object, the then at validateResolver fails.

I don't know what the intent was but my guess is that it should either:

• be documented that resolver should return a Promise
• fix validateResolver
  • it should use an async function or wrap the resolver in Promise.resolve so it can return either.
  • document that a resolver can return either.
  • fix the Resolver type.

[bluebill1049]

thanks, you are right will sort out the doc.

[Satyam]

Something also missing in the description of the resolver function is what is the purpose of the returned values object. It should state, somewhere in there, that the purpose of the resolver is to validate and to cast or transform the values to be submitted.

[bluebill1049]

feel free to send us a pr next time too.

[Satyam]

I forgot to mention that this is a change from earlier pre-V6 versions. I had a test where I had a mock function just to check whether the validation was being called, and it worked in earlier versions:

      const validate = jest.fn((values) =>
        ({
          values,
          errors: {},
        })
      );

Suddenly, it stopped working because of the then pointed out above. So, there is a backward compatibility issue at stake.

So, I'd love to make a PR, but which one?

[bluebill1049]

can you change to async func see if that will fix it? otherwise provide a codesandbox, happy to take a look at it.

[Satyam]

Done: #2305