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.

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

doc: add documentation for response.flushHeaders() #28807

Closed
wants to merge 2 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion doc/api/http.md
Original file line number Diff line number Diff line change
Expand Up @@ -614,7 +614,7 @@ request was initiated via [`http.get()`][].
added: v1.6.0
-->

Flush the request headers.
Flushes the request headers.

For efficiency reasons, Node.js normally buffers the request headers until
`request.end()` is called or the first chunk of request data is written. It
Expand Down Expand Up @@ -1185,6 +1185,13 @@ added: v0.0.2
The `response.finished` property will be `true` if [`response.end()`][]
has been called.

### response.flushHeaders()
<!-- YAML
added: v1.6.0
-->

Flushes the response headers. See also: [`request.flushHeaders()`][].

### response.getHeader(name)
<!-- YAML
added: v0.4.0
Expand Down Expand Up @@ -2207,6 +2214,7 @@ not abort the request or do anything besides add a `'timeout'` event.
[`new URL()`]: url.html#url_constructor_new_url_input_base
[`removeHeader(name)`]: #http_request_removeheader_name
[`request.end()`]: #http_request_end_data_encoding_callback
[`request.flushHeaders()`]: #http_request_flushheaders
[`request.getHeader()`]: #http_request_getheader_name
[`request.setHeader()`]: #http_request_setheader_name_value
[`request.setTimeout()`]: #http_request_settimeout_timeout_callback
Expand Down