Improve type information at Wildcard about v5-docs

[thetutlage]

Making the validator implement an interface doesn't sound intuitive to me. However, we can document that the messages property can use the CustomMessages type.

[thetutlage]

If you put the callback right within the messages object, you will get types automatically, without being explicit about them.

messages: {
  '*': (field, rule, arrayExpressionPointer, options) {

  }
}

With that being said. It is technically valid to extract the method to a different file or maybe at the top in the same file. However, documentation cannot show all the styles, as it makes the docs verbose.

[brkn]

But the validator classes doesn't have this type information, not in the documentation either. I felt the need to search the codebase itself instead of reading from the document, is there another way I can help to improve this experience?

[thetutlage]

Can you please share how this can be improved? Or maybe just send a PR with the improvement :)

[brkn]

I can think 2 solutions for the class validators

1. Import the CustomMessages interface at the example code in the validator classes documentation

import { schema, CustomMessages } from '@ioc:Adonis/Core/Validator'
import { HttpContextContract } from '@ioc:Adonis/Core/HttpContext'

export default class CreateUserValidator {
  constructor (protected ctx: HttpContextContract) {
  }

  public schema = schema.create({
  })

  public messages: CustomMessages = {}
}

2. Introduce an interface for validator class itself, then change the example to have implements Validator

export default class CreateUserValidator implements Validator{
// ...
}