Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Incorrect documentation for string().email() 'allowUnderscore' option #2972

Open
JeremyGendre opened this issue Aug 7, 2023 · 0 comments · May be fixed by #3005
Open

Incorrect documentation for string().email() 'allowUnderscore' option #2972

JeremyGendre opened this issue Aug 7, 2023 · 0 comments · May be fixed by #3005
Labels
documentation Non-code related changes

Comments

@JeremyGendre
Copy link

Context

  • node version: 18.11.0
  • module version: 17.9.1

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

To verify my email strings, i would like to allow underscores in the EmailOptions object. However, it seems that the allowUnderscore described in the 17.9.1 documentation doesn't actually exists.

Joi.string().email({ allowUnderscore: true }) // Error: Options contain unknown keys: allowUnderscore
@JeremyGendre JeremyGendre added the documentation Non-code related changes label Aug 7, 2023
@sbrsubuvga sbrsubuvga linked a pull request Nov 22, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Non-code related changes
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant