FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

docs: clarify top-level request option url fields by vibhor-aggr · Pull Request #5545 · nodejs/undici · GitHub

/ undici Public

docs: clarify top-level request option url fields - #5545

Merged
metcoder95 merged 1 commit into
nodejs:mainfrom
vibhor-aggr:docs/request-options-url-resolution
Jul 16, 2026
Merged

docs: clarify top-level request option url fields#5545
metcoder95 merged 1 commit into
nodejs:mainfrom
vibhor-aggr:docs/request-options-url-resolution

Conversation

Copy link
Copy Markdown
Contributor

Summary

Refs #1011.

Clarifies the distinction between top-level Undici API options and lower-level dispatcher options. Top-level calls like undici.request(url, options) get origin and path from the separate url argument, so those fields should not be supplied in the second options argument even though the linked dispatcher option docs include them.

Verification

  • git diff --check
  • npm run lint
  • npm run test:typescript

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.46%. Comparing base (c7c7e7f) to head (303a210).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #5545      +/-   ##
==========================================
+ Coverage   93.45%   93.46%   +0.01%     
==========================================
  Files         110      110              
  Lines       37376    37376              
==========================================
+ Hits        34928    34933       +5     
+ Misses       2448     2443       -5     

☔ View full report in Codecov by Harness.
📢 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.

mcollina left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

lgtm

Copy link
Copy Markdown
Contributor Author

The failing macOS Node 26 job looks unrelated to this docs-only change. The log shows test/issue-5087.js failing after the test ended because of Error: read ECONNRESET in headersTimeout over h2 rejects with HeadersTimeoutError. I tried to rerun failed jobs through the Actions API, but GitHub returned 403 Must have admin rights to Repository. Could a maintainer rerun the failed job when convenient?

metcoder95 merged commit 7c84c90 into nodejs:main Jul 16, 2026
35 of 36 checks passed
github-actions Bot mentioned this pull request Jul 20, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
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.

4 participants


Back | FazBrowse Home | New Git URL