Skip to content

doc: document return value of dgram.Socket methods #66300

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

Open
BIGSUS24 wants to merge 1 commit into
base: main
Choose a base branch
from
+3 −0
Open

doc: document return value of dgram.Socket methods #66300

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions doc/api/dgram.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,7 @@ changes:
* `port` {integer}
* `address` {string}
* `callback` {Function} with no parameters. Called when binding is complete.
* Returns: {dgram.Socket} The socket itself.

For UDP sockets, causes the `dgram.Socket` to listen for datagram
messages on a named `port` and optional `address`. If `port` is not
Expand Down Expand Up @@ -319,6 +320,7 @@ added: v0.11.14
* `exclusive` {boolean}
* `fd` {integer}
* `callback` {Function}
* Returns: {dgram.Socket} The socket itself.

For UDP sockets, causes the `dgram.Socket` to listen for datagram
messages on a named `port` and optional `address` that are passed as
Expand Down Expand Up @@ -410,6 +412,7 @@ added: v0.1.99
-->

* `callback` {Function} Called when the socket has been closed.
* Returns: {dgram.Socket} The socket itself.

Close the underlying socket and stop listening for data on it. If a callback is
provided, it is added as a listener for the [`'close'`][] event.
Expand Down
Loading