Skip to content

doc: declare all parameter types #21782

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
rubys wants to merge 6 commits into from
Closed

doc: declare all parameter types #21782

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3ea7324
doc: declare all parameter types
rubys Jul 12, 2018
252c4bc
consistently use '*' for parameter lists
rubys Jul 12, 2018
f681244
{object} => {Object}, {function} => {Function}
rubys Jul 12, 2018
3ffc671
address GitHub comments
rubys Jul 13, 2018
16cee69
address more comments
rubys Jul 13, 2018
888f667
setuid may be a string
rubys Jul 14, 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
Prev Previous commit
Next Next commit
{object} => {Object}, {function} => {Function}
  • Loading branch information
@rubys
rubys committed Jul 14, 2018
commit f6812443adfe423ec325e7fce78a836c351b6f7b
16 changes: 8 additions & 8 deletions doc/api/net.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -671,7 +671,7 @@ callback.
added: v0.1.90
-->

* `exception` {object}
* `exception` {Object}
* Returns: {net.Socket}

Ensures that no more I/O activity happens on this socket. Only necessary in
Expand Down Expand Up @@ -812,7 +812,7 @@ added: v0.1.90
-->

* `timeout` {number}
* `callback` {function}
* `callback` {Function}
* Returns: {net.Socket} The socket itself.

Sets the socket to timeout after `timeout` milliseconds of inactivity on
Expand Down Expand Up @@ -886,8 +886,8 @@ Possible signatures:
<!-- YAML
added: v0.7.0
-->
* `options` {object}
* `connectListener` {function}
* `options` {Object}
* `connectListener` {Function}
Alias to
[`net.createConnection(options[, connectListener])`][`net.createConnection(options)`].

Expand All @@ -896,7 +896,7 @@ Alias to
added: v0.1.90
-->
* `path` {string}
* `connectListener` {function}
* `connectListener` {Function}

Alias to
[`net.createConnection(path[, connectListener])`][`net.createConnection(path)`].
Expand All @@ -907,7 +907,7 @@ added: v0.1.90
-->
* `port` {number}
* `host` {string}
* `connectListener` {function}
* `connectListener` {Function}

Alias to
[`net.createConnection(port[, host][, connectListener])`][`net.createConnection(port, host)`].
Expand Down Expand Up @@ -1030,8 +1030,8 @@ then returns the `net.Socket` that starts the connection.
<!-- YAML
added: v0.5.0
-->
* `options` {object}
* `connectionListener` {function}
* `options` {Object}
* `connectionListener` {Function}

Creates a new TCP or [IPC][] server.

Expand Down
Loading