Skip to content

doc: document http agent options property#63351

Open
MukundaKatta wants to merge 1 commit into
nodejs:mainfrom
MukundaKatta:codex/doc-http-agent-options
Open

doc: document http agent options property#63351
MukundaKatta wants to merge 1 commit into
nodejs:mainfrom
MukundaKatta:codex/doc-http-agent-options

Conversation

@MukundaKatta
Copy link
Copy Markdown

@MukundaKatta MukundaKatta commented May 15, 2026

Refs: #60914

This documents agent.options so users do not need to rely on source inspection when deriving a custom Agent from http.globalAgent.options.

Changes

  • add an agent.options documentation entry
  • mention that it is the shallow copied and normalized options object used for new connections
  • add a cross-reference for http.globalAgent.options

Validation

  • node tools/lint-md/lint-md.mjs doc/api/http.md
  • git diff --check

@nodejs-github-bot
Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/http
  • @nodejs/net

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. http Issues or PRs related to the http subsystem. labels May 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Issues and PRs related to the documentations. http Issues or PRs related to the http subsystem.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants