Skip to content

Commit

Permalink
doc: add net socket write signature
Browse files Browse the repository at this point in the history
PR-URL: #19967
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
  • Loading branch information
Gurin, Sebastian authored and jasnell committed Apr 16, 2018
1 parent d7b162c commit e635723
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions doc/api/net.md
Original file line number Diff line number Diff line change
Expand Up @@ -834,6 +834,9 @@ active socket in the event system. If the socket is already `unref`ed 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 @@ -846,6 +849,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 @@ -1149,5 +1155,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

0 comments on commit e635723

Please sign in to comment.