Corrected documented type for defaultValue

[mjomble]

Updated the type in the table to match the extended description below

[changeset-bot]

💥 No Changeset

Latest commit: 97aac7b

Merging this PR will not cause any packages to be released. If these changes should not cause updates to packages in this repo, this is fine 🙂

If these changes should be published to npm, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[Vultraz]

So, interestingly, the mention of Function was deliberately removed from the table since there were various issues with Function values of defaultValue... (#2043, #2370)... except my testing seemed to indicate they were fixed in at least some cases (for non-required fields, at least). So... the current behavior definitely needs some clarification.

[MadeByMike]

The base field class implements a getDefaultValue method that looks like this:

  getDefaultValue({ context, originalInput, actions }) {
    if (typeof this.defaultValue !== 'undefined') {
      if (typeof this.defaultValue === 'function') {
        return this.defaultValue({ context, originalInput, actions });
      } else {
        return this.defaultValue;
      }
    }
    // By default, the default value is undefined
    return undefined;
  }

This can be changed in the implementation for individual field types, but none of our fields currently change it.

This means defaultValue can really be anything. (String | Function | null) is not really accurate as many fields don't expect a string.

[MadeByMike]

I attempted a wording change. Is this better or more confusing? Can we make it simpler without skipping important detail.