Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

api docs say incomingMessage.headers is read-only but it is not #3146

Closed
kapouer opened this issue Oct 1, 2015 · 0 comments
Closed

api docs say incomingMessage.headers is read-only but it is not #3146

kapouer opened this issue Oct 1, 2015 · 0 comments
Labels
doc Issues and PRs related to the documentations. http Issues or PRs related to the http subsystem.

Comments

@kapouer
Copy link
Contributor

kapouer commented Oct 1, 2015

While http documentation says it is a Read-Only map, it isn't and nothing (not event tests) prevent from writing to an incoming message headers.
This is actually a feature which some might find useful (for writing express middlewares), so my
suggestion is to fix the documentation, not the code.
@mscdex mscdex added http Issues or PRs related to the http subsystem. doc Issues and PRs related to the documentations. labels Oct 1, 2015
tflanagan added a commit to tflanagan/node that referenced this issue Nov 13, 2015
@tflanagan
doc: reword message.headers
7d2b47b 
message.headers states that the headers are read-only, when in fact they
are not. This change rewords the docs to a more appropriate description,
while not promoting this kind of behavior.

Issue: nodejs#3146
@tflanagan tflanagan mentioned this issue Nov 13, 2015
Closed
Fishrock123 pushed a commit that referenced this issue Nov 17, 2015
@tflanagan @Fishrock123
doc: reword message.headers to indicate they are not read-only
5d1faa2 
message.headers states that the headers are read-only, when in fact they
are not. This change rewords the docs to a more appropriate description,
while not promoting this kind of behavior.

Fixes: #3146
PR-URL: #3814
Reviewed-By: Roman Klauke <[email protected]>
Reviewed-By: James M Snell <[email protected]>
MylesBorins pushed a commit that referenced this issue Nov 17, 2015
@tflanagan
doc: reword message.headers to indicate they are not read-only
fc629c2 
message.headers states that the headers are read-only, when in fact they
are not. This change rewords the docs to a more appropriate description,
while not promoting this kind of behavior.

Fixes: #3146
PR-URL: #3814
Reviewed-By: Roman Klauke <[email protected]>
Reviewed-By: James M Snell <[email protected]>
rvagg pushed a commit that referenced this issue Dec 4, 2015
@tflanagan @rvagg
doc: reword message.headers to indicate they are not read-only
1d5cbe7 
message.headers states that the headers are read-only, when in fact they
are not. This change rewords the docs to a more appropriate description,
while not promoting this kind of behavior.

Fixes: #3146
PR-URL: #3814
Reviewed-By: Roman Klauke <[email protected]>
Reviewed-By: James M Snell <[email protected]>
jasnell pushed a commit that referenced this issue Dec 17, 2015
@tflanagan @jasnell
doc: reword message.headers to indicate they are not read-only
a36a5b6 
message.headers states that the headers are read-only, when in fact they
are not. This change rewords the docs to a more appropriate description,
while not promoting this kind of behavior.

Fixes: #3146
PR-URL: #3814
Reviewed-By: Roman Klauke <[email protected]>
Reviewed-By: James M Snell <[email protected]>
jasnell pushed a commit that referenced this issue Dec 23, 2015
@tflanagan @jasnell
doc: reword message.headers to indicate they are not read-only
630ddfd 
message.headers states that the headers are read-only, when in fact they
are not. This change rewords the docs to a more appropriate description,
while not promoting this kind of behavior.

Fixes: #3146
PR-URL: #3814
Reviewed-By: Roman Klauke <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. http Issues or PRs related to the http subsystem.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mscdex @kapouer