Skip to content

types: document Client and H2CClient option declarations#4998

Merged
mcollina merged 1 commit intonodejs:mainfrom
trivikr:client.d.ts
Apr 8, 2026
Merged

types: document Client and H2CClient option declarations#4998
mcollina merged 1 commit intonodejs:mainfrom
trivikr:client.d.ts

Conversation

@trivikr
Copy link
Copy Markdown
Member

@trivikr trivikr commented Apr 8, 2026

This relates to...

Documentation coverage for the TypeScript declarations in types/client.d.ts and types/h2c-client.d.ts.

Rationale

Both declaration files had /** TODO */ placeholders for public options. Replacing those with real API docs makes the type surface easier to use in editors and keeps the declarations aligned with the documented client options.

Changes

  • Replaced placeholder comments in types/client.d.ts
  • Replaced placeholder comments in types/h2c-client.d.ts
  • Added descriptions for:
    • connectTimeout
    • socketPath
    • maxCachedSessions
    • connect
    • maxRequestsPerClient
    • localAddress

Features

N/A

Bug Fixes

N/A

Breaking Changes and Deprecations

N/A

Status

Signed-off-by: Kamat, Trivikram <16024985+trivikr@users.noreply.github.com>
@codecov-commenter
Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.92%. Comparing base (743aa89) to head (e8aca10).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4998   +/-   ##
=======================================
  Coverage   92.92%   92.92%           
=======================================
  Files         110      110           
  Lines       35729    35729           
=======================================
  Hits        33201    33201           
  Misses       2528     2528           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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 d3ea390 into nodejs:main Apr 8, 2026
35 checks passed
@trivikr trivikr deleted the client.d.ts branch April 8, 2026 15:58
@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.

3 participants