docs: fix unwrap literal union

[ST-DDT]

Restore the unwrapping of literal unions (broken due to the readonly array modifier/type operator).

• value: LiteralUnion<'a' | 'b'> -> 'a' | 'b' | string
• namedValue: LiteralUnion<AB> -> AB | string
• array: readonly LiteralUnion<'a' | 'b'>[] -> readonly ('a' | 'b' | string)[]
• namedArray: readonly LiteralUnion<AB>[] -> readonly (AB | string)[]

This also fixes an issue with missing parenthesis in union array types.

I found these issues when testing changes for #1732, but the PRs are unrelated to each other.

Preview Diff

Old

New

This mainly has an impact on the string module, but also affects weightedArrayElement (See also #1753).

Preview Diff

->

(We might want to expand this similar to the usual options object in the future)

Note: We replace LiteralUnions<X, Y> with X | Y because it is shorter and easier to understand (#811).

[codecov]

Codecov Report

Merging #1752 (4a722db) into next (b86638d) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files

@@           Coverage Diff           @@
##             next    #1752   +/-   ##
=======================================
  Coverage   99.64%   99.64%           
=======================================
  Files        2340     2340           
  Lines      242669   242669           
  Branches     1112     1112           
=======================================
  Hits       241819   241819           
  Misses        829      829           
  Partials       21       21           

[matthewmayer]

Would there be value in having the generated HTML documents (like ./docs/.vitepress/dist) included in the repo? Then when changes like this are made, it would be easy to see the effect of the changes (effectively a snapshot test).

[ST-DDT]

Would there be value in having the generated HTML documents (like ./docs/.vitepress/dist) included in the repo? Then when changes like this are made, it would be easy to see the effect of the changes (effectively a snapshot test).

• Make possible to preview docs of a PR on demand via netlify-preview #815
• Add api docs diff to the PR #1754

[ST-DDT]

Waiting for #1755
Then I will have another look at readonly && short.

[ST-DDT]

For anybody interested in reviewing this:

docs diff

Documentation changes detected:

• Datatype
  • array
• Date.* + Git.commitDate (feat(date): introduce faker.defaultRefDate and setDefaultRefDate #1757)
• Helpers
  • arrayElement
  • arrayElements
  • mustache
  • uniqueArray
  • weightedArrayElement
• Random
  • alpha
  • alphaNumeric
  • numeric
• String
  • alpha
  • alphanumeric
  • fromCharacters
  • numeric

(Parameter or return type changed, diff created by #1755)

(generated for 310c78c)