jquense / yup

Dead simple Object schema validation
MIT License
22.83k stars 932 forks source link

Documentation unclear on what shape() array argument does #1565

Open createthis opened 2 years ago

createthis commented 2 years ago

Describe the bug The documentation for the shape() method shows an Array argument: https://github.com/jquense/yup#objectshapefields-object-nosortedges-arraystring-string-schema

However, it doesn't say what it does or how it should be used.

There are a couple of issues that mention it in regard to Cyclic Dependency errors:

Is the purpose of the array argument to avoid Cyclic Dependency issues? How does that work?

Expected behavior It would be nice to have this Array argument documented.

niko-la-petrovic commented 1 week ago

Would be nice to document this. It's been 2 years