fix(type-annotations): space union separators in type values

[btea]

Description

In the documentation, parameter descriptions should be similar to parameter types in the code, with spaces between multiple types and the | identifier for a more consistent look.

old	new

Validation

Related Issues

Check List

• I have read the Contributing Guidelines and made commit messages that follow the guideline.
• I have run node --run test and all tests passed.
• I have check code formatting with node --run format & node --run lint.
• I've covered new added functionality with unit tests if necessary.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
api-docs-tooling	Ready	Preview	Jul 26, 2026 4:24am

[Copilot]

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

[vercel]

@btea is attempting to deploy a commit to the OpenJS Foundation Team on Vercel.

A member of the Team first needs to authorize it.

[cursor]

PR Summary

Low Risk
Localized formatting in the type-annotation markdown pipeline; no auth, data, or runtime API changes, though link offsets could theoretically shift if they were computed against pre-normalization strings elsewhere.

Overview
Type annotation values parsed from {...} prose are now canonicalized with spaced union separators (string | URL instead of string|URL), including GFM table escapes and messy whitespace, so rendered docs match typical TypeScript style.

Normalization runs in typeAnnotationFromMarkdown via a new UNION_SEPARATOR regex that rewrites lone | while leaving || unchanged (e.g. default-value expressions like req.url || '/'). Remark tests and a patch changeset cover the behavior and markdown round-trip.

^{Reviewed by Cursor Bugbot for commit 3b70340. Bugbot is set up for automated code reviews on this repo. Configure here.}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.20%. Comparing base (38710ef) to head (3b70340).

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #942      +/-   ##
==========================================
+ Coverage   86.19%   86.20%   +0.01%     
==========================================
  Files         195      195              
  Lines       17657    17673      +16     
  Branches     1605     1606       +1     
==========================================
+ Hits        15219    15235      +16     
  Misses       2432     2432              
  Partials        6        6              

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[cursor]

Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.

^{❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.}

Want fixes drafted automatically? Bugbot Autofix can create code changes for findings. A team admin can enable Autofix in the Cursor dashboard.

^{Reviewed by Cursor Bugbot for commit 1106e95. Configure here.}

[avivkeller]

Please add a patch changeset, thank you!

[Copilot]

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

[btea]

Please add a patch changeset, thank you!

Done.

[Copilot]

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

[AugustinMauroy]

LGMT !