Skip to content

docs: Change the default value of allowH2 in JSDoc#5009

Merged
mcollina merged 1 commit intonodejs:mainfrom
7hokerz:fix-allowH2-JSDoc
Apr 9, 2026
Merged

docs: Change the default value of allowH2 in JSDoc#5009
mcollina merged 1 commit intonodejs:mainfrom
7hokerz:fix-allowH2-JSDoc

Conversation

@7hokerz
Copy link
Copy Markdown
Contributor

@7hokerz 7hokerz commented Apr 9, 2026

This relates to...

Docs

Rationale

release: https://github.com/nodejs/undici/releases/tag/v8.0.0
Recently, the default value of allowH2 was changed from false to true.

docs: https://github.com/nodejs/undici/blob/main/docs/docs/api/Client.md
And the above document specifies that the default value of allowH2 is true.

However, this was missing from the JSDoc in the code.

Changes

chore docs update

update JSDoc in client.d.ts

Features

N/A

Bug Fixes

N/A

Breaking Changes and Deprecations

N/A

Status

Copy link
Copy Markdown
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@mcollina mcollina merged commit 4e4c2a3 into nodejs:main Apr 9, 2026
@7hokerz 7hokerz deleted the fix-allowH2-JSDoc branch April 9, 2026 15:52
@github-actions github-actions bot mentioned this pull request Apr 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants