1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: add net socket write signature

Browse Source 
PR-URL: https://github.com/nodejs/node/pull/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>
This commit is contained in:
Gurin, Sebastian 2018-04-12 03:15:56 -03:00 committed by Ruben Bridgewater
parent 61e232b9b8
commit 8e305890c9
No known key found for this signature in database
GPG Key ID: F07496B3EB3C1762
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/api/net.md
View File

@ -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
@ -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
@ -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