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
+7 −0
Closed

net socket write signature docs #19967

Changes from 2 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
6 changes: 6 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}
Copy link
Member

Choose a reason for hiding this comment

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

Uint8Array is also accepted.

Copy link
Author

Choose a reason for hiding this comment

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

added

* `encoding` {string} **Default:** `UTF8`
Copy link
Contributor

Choose a reason for hiding this comment

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

It seems this should be `'utf8'`

Copy link
Member

Choose a reason for hiding this comment

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

Also to be strict, we could specify that it is only used when data is a string but maybe it's obvious.

Copy link
Author

Choose a reason for hiding this comment

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

done & done

* `callback` {Function}
* Returns: {boolean}

Sends data on the socket. The second parameter specifies the encoding in the
Expand All @@ -837,6 +840,8 @@ 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.
Copy link
Member

@lpinca lpinca Apr 12, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

It's probably better to link to https://nodejs.org/dist/latest/docs/api/stream.html#stream_writable_write_chunk_encoding_callback instead of _write()

Copy link
Author

Choose a reason for hiding this comment

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

done


## net.connect()

Aliases to
Expand Down Expand Up @@ -1142,3 +1147,4 @@ Returns `true` if input is a version 6 IP address, otherwise returns `false`.
[socket(7)]: http://man7.org/linux/man-pages/man7/socket.7.html
[unspecified IPv4 address]: https://en.wikipedia.org/wiki/0.0.0.0
[unspecified IPv6 address]: https://en.wikipedia.org/wiki/IPv6_address#Unspecified_address
[stream_writable_write]: stream.html#stream_writable_write_chunk_encoding_callback_1