improve Flatten errors section's (issues guide) example
#940
Conversation
The example under the `Flatten errors` section uses a `nested` key to define the object schema. This might confuse the readers, as the result returned by the `flatten` function might also use `nested` as a key to return nested issues.
commit: |
|
Another option would be to rename the keys to |
|
I am not sure if I understand. We can't rename the key returned by the To provide more context: While reading the section, initially I was confused. I think we can improve this using a different name that is not one of the standard keys returned by the |
You are right. My previous comment doesn't make sense. Sorry about that. It may be better to rename all the keys. What do you think? Here is an example: const ObjectSchema = v.object({
foo: v.string('Value of "key" is missing.'),
bar: v.object({
baz: v.string('Value of "nested.key" is missing.'),
}),
}); |
|
Renaming all of the keys is even better! Will update this PR shortly. |
Update the key names to something else than the current so that the reader is not confused after reading it.
make the displayed path items consistent by adding `value` keys
The example under the
Flatten errorssection uses anestedkey to define the object schema. This might confuse the readers, as the result returned by theflattenfunction might also usenestedas a key to indicate nested issues.Before:
After:
