Skip to content

net socket write signature docs #19967

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 5 commits into from
Closed

net socket write signature docs #19967

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c92685b
net socket write signature docs
Apr 12, 2018
277c8ae
add reference to stream writable _write()
Apr 12, 2018
94de469
stream write docs: reference write(), add Uint8Array input type
Apr 12, 2018
1a48c06
docs socket write encoding param comment
Apr 12, 2018
f3dd57c
doc socket write fix
cancerberoSgx Apr 12, 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
7 changes: 7 additions & 0 deletions doc/api/net.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -825,6 +825,9 @@ active socket in the event system. If the socket is already `unref`d calling
added: v0.1.90
-->

* `data` {string|Buffer|Uint8Array}
* `encoding` {string} Only used when data is `string`. **Default:** `utf8`.
* `callback` {Function}
* Returns: {boolean}

Sends data on the socket. The second parameter specifies the encoding in the
Expand All @@ -837,6 +840,9 @@ buffer. Returns `false` if all or part of the data was queued in user memory.
The optional `callback` parameter will be executed when the data is finally
written out - this may not be immediately.

See Writable stream [`write()`][stream_writable_write] method for more
information.

## net.connect()

Aliases to
Expand Down Expand Up @@ -1140,5 +1146,6 @@ Returns `true` if input is a version 6 IP address, otherwise returns `false`.
[duplex stream]: stream.html#stream_class_stream_duplex
[half-closed]: https://tools.ietf.org/html/rfc1122
[socket(7)]: http://man7.org/linux/man-pages/man7/socket.7.html
[stream_writable_write]: stream.html#stream_writable_write_chunk_encoding_callback
[unspecified IPv4 address]: https://en.wikipedia.org/wiki/0.0.0.0
[unspecified IPv6 address]: https://en.wikipedia.org/wiki/IPv6_address#Unspecified_address