Skip to content

doc: add documentation for http.IncomingMessage$complete #23914

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

Closed
wants to merge 2 commits into from
Closed

doc: add documentation for http.IncomingMessage$complete #23914

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f1a4ce8
doc: add documentation for http.IncomingMessage$complete
jasnell Oct 26, 2018
2b953e1
[Squash] suggestion
vsemozhetbyt Oct 29, 2018
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
28 changes: 28 additions & 0 deletions doc/api/http.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1500,6 +1500,34 @@ added: v10.1.0
The `message.aborted` property will be `true` if the request has
been aborted.

### message.complete
<!-- YAML
added: v0.3.0
-->

* {boolean}

The `message.complete` property will be `true` if a complete HTTP message has
been received and successfully parsed.

This property is particularly useful as a means of determining if a client or
server fully transmitted a message before a connection was terminated:

```js
const req = http.request({
host: '127.0.0.1',
port: 8080,
method: 'POST'
}, (response) => {
res.resume();
res.on('end', () => {
if (!res.complete)
console.error(
'The connection was terminated while the message was still being sent');
});
});
```

### message.destroy([error])
<!-- YAML
added: v0.3.0
Expand Down