Tuple describe() method

[DaddyWarbucks]

This PR addresses: #1891

The code aims to standardize how Array and Tuple inner types are configured. Historically array has stored it's one inner type on a prop innerType. Tuple has stored its types in spec.types. The types MUST be stored on the spec object for Tuple because it is needed for the notType method. See:

yup/src/locale.ts

Line 137 in f37a53f

notType: (params) => {

Both Array and Tuple now have schema.innerType and schema.spec.innerType. This was done for backwards compatibility and consistency. And all corresponding methods and types have been updated.

This now allows the Tuple to return information about its types in the describe method

const description = tuple([string(), number()]).describe();

description = {
  type: 'tuple',
  innerType: [
    { type: 'string },
    { type: 'number' }
  ]
}

Let me know if you have any questions!

[jquense]

i'd rather keep the types name, i wanted to migrate array to use it it as well but opted to avoid the breaking change

[DaddyWarbucks]

OK. I can change that back to types. I suppose that is actually a breaking change too, so it should remain types. Its a bummer I didn't get to this before the official release of V1 🤷

What should I do with Array?
1 - Return it to its current shape (no spec)
2 - Add spec.innerType = {...the one type}
3 - Add spec.types = [{ ...the one type }] // note the array
4 - Add spec.types = { ...the one type } // note no array
5 - Add spec.type = { ...the one type } // note spec is singular

I am leaning towards option 3. It seems most consistent with Tuple. And if there is ever another use case for some "inner type", then the property types with an array is flexible.

[jquense]

I think 3 makes sense to me 👍

[DaddyWarbucks]

While I've got your eyes on this, this appears to be a bug in the array schema:

yup/src/array.ts

Line 272 in b0e67ef

base.innerType = this.innerType.describe(options);

Shouldn't that pass innerOptions?

[DaddyWarbucks]

@jquense All updates have been made. let me know if you have anymore questions or concerns.

[jquense]

thanks!