Repository navigation
http module documented default behavior only triggered if undocumented option is set #53035
Description
Activity
Thanks! If you'd like, you can submit a PR updating the documentation, and the team will be more than happy to review :-)
I'd like to submit a PR but I'm not sure about which way to go about it.
rejectNonStandardBodyWritesis not documented and is not part of the typescript types either. I don't know if that omission is intentional or not; I have not been able find any discussion about it.Should I somehow add that to the documentation, and separately push it for
@types/nodeand document the actual behavior? Or should I just remove the part from the documentation that says:Writing to the body is not allowed when the request method or response status do not support content. If an attempt is made to write to the body for a HEAD request or as part of a 204 or 304response, a synchronous Error with the code ERR_HTTP_BODY_NOT_ALLOWED is thrown.
Not sure which way this should go right now.
@nodejs/http
@earslap The omission is not intentional. The author of the PR was supposed to sent a fix-up PR for docs (and types) but never did. See: #47732 (comment)
You are more than welcome to send your PR.
Reacted by Batuhan Bozkurt and Aviv Keller- added a commit that references this issue
on Jun 11, 2024 - added a commit that references this issue
on Jun 20, 2024 - added a commit that references this issue
on Jun 20, 2024
Affected URL(s)
https://nodejs.org/api/http.html#responsewritechunk-encoding-callback
Description of the problem
For the http module, the documentation for
response.writesays:However this is not the default behavior. By default, nodejs swallows the provided body and prints the debug message (enabled by
NODE_DEBUG=http):The documented behavior (throwing ERR_HTTP_BODY_NOT_ALLOWED) happens only when
rejectNonStandardBodyWritesoption is set totruewhile creating a server withcreateServer. However this option is not documented, it does not exist in@node/typeseither.