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

docs: added documentation for socket.destroyed #6128

Closed
wants to merge 7 commits into from
Closed

docs: added documentation for socket.destroyed #6128

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
af3955f
docs: added documentation for socket.destroyed
tusharmath Apr 9, 2016
946ad38
Merge branch 'master' into patch-1
tusharmath Apr 22, 2016
70c678c
fixup! docs: added documentation for socket.destroyed
tusharmath Apr 22, 2016
9154c97
fixup! docs: added documentation for socket.destroyed
tusharmath Jun 16, 2016
deaaf25
fixup! docs: added documentation for socket.destroyed
tusharmath Jun 17, 2016
04cdc53
fixup! docs: added documentation for socket.destroyed
tusharmath Jun 18, 2016
2230d96
fixup! docs: added documentation for socket.destroyed
tusharmath Jun 20, 2016
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
4 changes: 4 additions & 0 deletions doc/api/net.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -359,6 +359,10 @@ The amount of received bytes.

The amount of bytes sent.

### socket.destroyed

A `boolean` value that depicts if the connection is destroyed or not.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add a bit more detail about what "destroyed" means?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For example?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Look into the source to find out, I think something along the lines of "does not send or receive any more data, cannot be re-established", but I'm no expert on this topic :).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think "indicates" might be a better choice of word than "depicts". Maybe something like this:

A Boolean value that indicates whether the connection has been destroyed or not.


### socket.connect(options[, connectListener])

Opens the connection for a given socket.
Expand Down