react: use link colors for inline type annotations by adityareddy-dev · Pull Request #1245 · nodejs/doc-kit

adityareddy-dev · 2026-11-05T08:31:30Z

Description

I made linked type annotations use the link color in both themes, so WeakSet and Promise have the same style.

Validation

The screenshots below show the linked types in both themes.

Light theme:

Dark theme:

Related Issues

Fixes #1054

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:check & node --run lint.
I've covered new added functionality with unit tests if necessary.

Signed-off-by: Aditya Reddy <82123567+adityareddy-dev@users.noreply.github.com>

vercel · 2026-11-05T08:31:35Z

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

Project	Deployment	Actions	Updated
api-docs-tooling	Ready	Preview	Nov 5, 2026 7:55pm UTC

adityareddy-dev · 2026-11-05T08:59:08Z

Could someone approve the workflow runs? PR Quality also can't start because the repository's Actions settings don't allow the shared workflow from webpack/.github.

codecov · 2026-11-05T12:53:18Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.13%. Comparing base (9d02e94) to head (4cf00b8).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1245      +/-   ##
==========================================
- Coverage   94.14%   94.13%   -0.01%     
==========================================
  Files         291      291              
  Lines       28908    28900       -8     
  Branches     2936     2932       -4     
==========================================
- Hits        27214    27206       -8     
  Misses       1672     1672              
  Partials       22       22

☔ 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.

github-actions · 2026-11-05T12:54:02Z

`api-links` Generator

Performance estimate _{(single CI run)}

Generation time: 9.9% faster (910.00 ms → 820.00 ms)
Peak memory: 1.3% lower (281.43 MB → 277.74 MB)

`json` Generator

Output: 6 files differ

buffer.json

Expected values to be strictly deep-equal:
+ actual - expected
... Skipped lines

  {
    '$schema': 'https://doc-kit.nodejs.org/schemas/api-doc/1.0.1.json',
    added: [],
    changes: [],
    children: [
...
            ],
+           id: 'the---zero-fill-buffers-command-line-option',
-           id: '-zero-fill-buffers-command-line-option',
            kind: 'section',
            name: 'The --zero-fill-buffers command-line option',
            napiVersion: [],
            overloadOf: null,
            removed: [],

cli.json

Expected values to be strictly deep-equal:
+ actual - expected
... Skipped lines

  {
    '$schema': 'https://doc-kit.nodejs.org/schemas/api-doc/1.0.1.json',
    added: [],
    changes: [],
    children: [
...
            examples: [],
+           id: '-c---check',
-           id: '-check',
            kind: 'section',
            name: '-c, --check',
            napiVersion: [],
            overloadOf: null,
            removed: [],
...
            ],
+           id: '-c-condition---conditionscondition',
-           id: '-conditionscondition',
            kind: 'section',
            name: '-C condition, --conditions=condition',
            napiVersion: [],
            overloadOf: null,
            removed: [],
...
            examples: [],
+           id: '-e---eval-script',
-           id: '-eval-script',
            kind: 'section',
            name: '-e, --eval "script"',
            napiVersion: [],
            overloadOf: null,
            removed: [],
...
            examples: [],
+           id: '-h---help',
-           id: '-help',
            kind: 'section',
            name: '-h, --help',
            napiVersion: [],
            overloadOf: null,
            removed: [],
...
            examples: [],
+           id: '-i---interactive',
-           id: '-interactive',
            kind: 'section',
            name: '-i, --interactive',
            napiVersion: [],
            overloadOf: null,
            removed: [],
...
            examples: [],
+           id: '-p---print-script',
-           id: '-print-script',
            kind: 'section',
            name: '-p, --print "script"',
            napiVersion: [],
            overloadOf: null,
            removed: [],
...
            examples: [],
+           id: '-r---require-module',
-           id: '-require-module',
            kind: 'section',
            name: '-r, --require module',
            napiVersion: [],
            overloadOf: null,
            removed: [],
...
            examples: [],
+           id: '-v---version',
-           id: '-version',
            kind: 'section',
            name: '-v, --version',
            napiVersion: [],
            overloadOf: null,
            removed: [],

module.json

Expected values to be strictly deep-equal:
+ actual - expected
... Skipped lines

  {
    '$schema': 'https://doc-kit.nodejs.org/schemas/api-doc/1.0.1.json',
    added: [],
    changes: [],
    children: [
...
                examples: [],
+               id: 'new-sourcemappayload--linelengths-',
-               id: '-linelengths',
                kind: 'constructor',
                name: 'SourceMap',
                napiVersion: [],
                overloadOf: null,
                removed: [],

single-executable-applications.json

Expected values to be strictly deep-equal:
+ actual - expected
... Skipped lines

  {
    '$schema': 'https://doc-kit.nodejs.org/schemas/api-doc/1.0.1.json',
    added: [
      'v19.7.0',
      'v18.16.0'
...
        ],
+       id: 'generating-single-executable-applications-with---build-sea',
-       id: '-build-sea',
        kind: 'section',
        name: 'Generating single executable applications with --build-sea',
        napiVersion: [],
        overloadOf: null,
        removed: [],

tls.json

Expected values to be strictly deep-equal:
+ actual - expected
... Skipped lines

  {
    '$schema': 'https://doc-kit.nodejs.org/schemas/api-doc/1.0.1.json',
    added: [],
    changes: [],
    children: [
...
            examples: [],
+           id: 'using---tls-cipher-list',
-           id: '-tls-cipher-list',
            kind: 'section',
            name: 'Using --tls-cipher-list',
            napiVersion: [],
            overloadOf: null,
            removed: [],

webstreams.json

Expected values to be strictly deep-equal:
+ actual - expected
... Skipped lines

  {
    '$schema': 'https://doc-kit.nodejs.org/schemas/api-doc/1.0.1.json',
    added: [
      'v16.5.0'
    ],
...
                examples: [],
+               id: 'new-readablestreamunderlyingsource--strategy',
-               id: '-strategy',
                kind: 'constructor',
                name: 'ReadableStream',
                napiVersion: [],
                overloadOf: null,
                removed: [],

Performance estimate _{(single CI run)}

Generation time: 35.2% slower (6.94 s → 9.38 s)
Peak memory: 0.0% lower (971.12 MB → 970.88 MB)

`legacy-html` Generator

Output size: 6 files changed · net +636.00 B

File size details

File	Main	PR	Change
`single-executable-applications.html`	127.78 KB	127.97 KB	+192.00 B (+0.1%)
`cli.html`	372.89 KB	373.06 KB	+168.00 B (+0.0%)
`webstreams.html`	297.01 KB	297.15 KB	+140.00 B (+0.0%)
`module.html`	364.54 KB	364.63 KB	+88.00 B (+0.0%)
`tls.html`	297.30 KB	297.33 KB	+28.00 B (+0.0%)
`buffer.html`	1.17 MB	1.17 MB	+20.00 B (+0.0%)

Performance estimate _{(single CI run)}

Generation time: 7.7% slower (16.32 s → 17.57 s)
Peak memory: 2.0% higher (1.44 GB → 1.47 GB)

`legacy-json` Generator

Performance estimate _{(single CI run)}

Generation time: 15.8% faster (6.76 s → 5.69 s)
Peak memory: 4.3% higher (958.73 MB → 1000.17 MB)

`llms-txt` Generator

Performance estimate _{(single CI run)}

Generation time: 34.1% faster (9.60 s → 6.33 s)
Peak memory: 11.7% higher (891.98 MB → 995.91 MB)

`orama-db` Generator

Output size: 1 file changed · net +2.89 KB

File size details

File	Main	PR	Change
`orama-db.json`	29.71 MB	29.71 MB	+2.89 KB (+0.0%)

Performance estimate _{(single CI run)}

Generation time: 17.0% faster (6.37 s → 5.29 s)
Peak memory: 6.9% higher (1020.07 MB → 1.07 GB)

`web` Generator

Output size: 9 files changed · net +1.06 KB

File size details

File	Main	PR	Change
`assets/style-DOjyqch-.css`	—	138.37 KB	+138.37 KB
`assets/style-oesv8pX0.css`	138.33 KB	—	-138.33 KB (-100.0%)
`all.html`	34.82 MB	34.82 MB	+522.00 B (+0.0%)
`single-executable-applications.html`	170.64 KB	170.83 KB	+192.00 B (+0.1%)
`cli.html`	678.99 KB	679.15 KB	+168.00 B (+0.0%)
`webstreams.html`	565.36 KB	565.43 KB	+70.00 B (+0.0%)
`module.html`	533.05 KB	533.09 KB	+44.00 B (+0.0%)
`tls.html`	550.15 KB	550.17 KB	+28.00 B (+0.0%)
`buffer.html`	1.82 MB	1.82 MB	+20.00 B (+0.0%)

Performance estimate _{(single CI run)}

Generation time: 20.6% slower (15.20 s → 18.33 s)
Peak memory: 5.3% lower (1.53 GB → 1.45 GB)

Signed-off-by: Aditya Reddy <82123567+adityareddy-dev@users.noreply.github.com>

adityareddy-dev · 2026-11-05T17:57:03Z

Fixed.

Signed-off-by: Aditya Reddy <82123567+adityareddy-dev@users.noreply.github.com>

react: use link colors for inline type annotations

a85665d

Signed-off-by: Aditya Reddy <82123567+adityareddy-dev@users.noreply.github.com>

adityareddy-dev requested a review from a team as a code owner November 5, 2026 08:31

vercel Bot deployed to Preview – api-docs-tooling November 5, 2026 08:32

View deployment

AugustinMauroy approved these changes Nov 5, 2026

View reviewed changes

This comment was marked as low quality.

Sign in to view

react: explain inline type color override

7a89f28

Signed-off-by: Aditya Reddy <82123567+adityareddy-dev@users.noreply.github.com>

vercel Bot deployed to Preview – api-docs-tooling November 5, 2026 17:55

View deployment

avivkeller reviewed Nov 5, 2026

View reviewed changes

Comment thread e2e/type-links.spec.js Resolved

react: remove type link CSS e2e test

4cf00b8

Signed-off-by: Aditya Reddy <82123567+adityareddy-dev@users.noreply.github.com>

vercel Bot deployed to Preview – api-docs-tooling November 5, 2026 19:55

View deployment

avivkeller approved these changes Nov 5, 2026

View reviewed changes

ryzrr approved these changes Nov 6, 2026

View reviewed changes

Navigation Menu

Repository navigation

react: use link colors for inline type annotations - #1245

react: use link colors for inline type annotations#1245
adityareddy-dev wants to merge 3 commits into
nodejs:mainfrom
adityareddy-dev:fix/inline-type-link-colors

adityareddy-dev commented Nov 5, 2026 •

edited

Loading

Uh oh!

vercel Bot commented Nov 5, 2026 •

edited

Loading

Uh oh!

adityareddy-dev commented Nov 5, 2026

Uh oh!

codecov Bot commented Nov 5, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Nov 5, 2026 •

edited

Loading

Uh oh!

This comment was marked as low quality.

Uh oh!

adityareddy-dev commented Nov 5, 2026

Uh oh!

Uh oh!

This branch was successfully deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

adityareddy-dev commented Nov 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Validation

Related Issues

Check List

Uh oh!

vercel Bot commented Nov 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

adityareddy-dev commented Nov 5, 2026

Uh oh!

codecov Bot commented Nov 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

github-actions Bot commented Nov 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

api-links Generator

json Generator

legacy-html Generator

legacy-json Generator

llms-txt Generator

orama-db Generator

web Generator

Uh oh!

This comment was marked as low quality.

Uh oh!

adityareddy-dev commented Nov 5, 2026

Uh oh!

Uh oh!

This branch was successfully deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

adityareddy-dev commented Nov 5, 2026 •

edited

Loading

vercel Bot commented Nov 5, 2026 •

edited

Loading

codecov Bot commented Nov 5, 2026 •

edited

Loading

github-actions Bot commented Nov 5, 2026 •

edited

Loading

`api-links` Generator

`json` Generator

`legacy-html` Generator

`legacy-json` Generator

`llms-txt` Generator

`orama-db` Generator

`web` Generator