doc/api: listed server.listen() parameters and made some minor corr… #39984
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
VoltrexKeyva
reviewed
Sep 3, 2021
doc/api/fs.md
Outdated
| @@ -2651,7 +2651,7 @@ changes: | |||
| Asynchronously creates a directory. | |||
|
|
|||
| The callback is given a possible exception and, if `recursive` is `true`, the | |||
| first directory path created, `(err, [path])`. | |||
| first directory path created, `(err [,path])`. | |||
There was a problem hiding this comment.
Suggested change
| first directory path created, `(err [,path])`. | |
| first directory path created, `(err[, path])`. |
VoltrexKeyva
reviewed
Sep 3, 2021
doc/api/fs.md
Outdated
| @@ -4871,7 +4871,7 @@ Returns the number of `bytesRead`. | |||
| For detailed information, see the documentation of the asynchronous version of | |||
| this API: [`fs.read()`][]. | |||
|
|
|||
| ### `fs.readSync(fd, buffer, [options])` | |||
| ### `fs.readSync(fd, buffer [,options])` | |||
There was a problem hiding this comment.
Suggested change
| ### `fs.readSync(fd, buffer [,options])` | |
| ### `fs.readSync(fd, buffer[, options])` |
VoltrexKeyva
reviewed
Sep 3, 2021
doc/api/http.md
Outdated
| @@ -1290,7 +1290,11 @@ event is emitted on the server object, and (by default) the socket is destroyed. | |||
| See [`server.timeout`][] for more information on how timeout behavior can be | |||
| customized. | |||
|
|
|||
| ### `server.listen()` | |||
| ### `server.listen(Port [,host] [,callback])` | |||
There was a problem hiding this comment.
Suggested change
| ### `server.listen(Port [,host] [,callback])` | |
| ### `server.listen(port[, host[, callback]])` |
VoltrexKeyva
reviewed
Sep 3, 2021
doc/api/http.md
Outdated
Comment on lines
1295
to
1297
| * `Port` {Number} | ||
| * `Host` {String} | ||
| * `callback` {Function} |
There was a problem hiding this comment.
Suggested change
| * `Port` {Number} | |
| * `Host` {String} | |
| * `callback` {Function} | |
| * `port` {number} | |
| * `host` {string} | |
| * `callback` {Function} |
VoltrexKeyva
reviewed
Sep 3, 2021
doc/api/stream.md
Outdated
| @@ -2041,7 +2041,7 @@ await finished(compose(s1, s2, s3)); | |||
| console.log(res); // prints 'HELLOWORLD' | |||
| ``` | |||
|
|
|||
| ### `stream.Readable.from(iterable, [options])` | |||
| ### `stream.Readable.from(iterable [,options])` | |||
There was a problem hiding this comment.
Suggested change
| ### `stream.Readable.from(iterable [,options])` | |
| ### `stream.Readable.from(iterable[, options])` |
jasnell
approved these changes
Sep 3, 2021
mscdex
reviewed
Sep 3, 2021
doc/api/http.md
Outdated
| @@ -1290,7 +1290,11 @@ event is emitted on the server object, and (by default) the socket is destroyed. | |||
| See [`server.timeout`][] for more information on how timeout behavior can be | |||
| customized. | |||
|
|
|||
| ### `server.listen()` | |||
| ### `server.listen(Port[, host][, callback])` | |||
There was a problem hiding this comment.
Suggested change
| ### `server.listen(Port[, host][, callback])` | |
| ### `server.listen(port[, host][, callback])` |
mscdex
reviewed
Sep 3, 2021
doc/api/http.md
Outdated
| ### `server.listen()` | ||
| ### `server.listen(Port[, host][, callback])` | ||
|
|
||
| * `Port` {number} |
There was a problem hiding this comment.
Suggested change
| * `Port` {number} | |
| * `port` {number} |
mscdex
reviewed
Sep 3, 2021
doc/api/http.md
Outdated
| ### `server.listen(Port[, host][, callback])` | ||
|
|
||
| * `Port` {number} | ||
| * `Host` {string} |
There was a problem hiding this comment.
Suggested change
| * `Host` {string} | |
| * `host` {string} |
doc/api/http.md: listed server.listen() parameters
lpinca
requested changes
Sep 4, 2021
doc/api/http.md
Outdated
| @@ -1290,7 +1290,11 @@ event is emitted on the server object, and (by default) the socket is destroyed. | |||
| See [`server.timeout`][] for more information on how timeout behavior can be | |||
| customized. | |||
|
|
|||
| ### `server.listen()` | |||
| ### `server.listen(port[, host][, callback])` | |||
There was a problem hiding this comment.
Please keep it as is. server.listen() has multiple signatures. See https://nodejs.org/api/net.html#net_server_listen.
lpinca
approved these changes
Sep 5, 2021
VoltrexKeyva
added
the
author ready
targos
pushed a commit
that referenced
this pull request
Sep 18, 2021
PR-URL: #39984 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
|
Landed in f4292bc |
BethGriggs
pushed a commit
that referenced
this pull request
Sep 21, 2021
PR-URL: #39984 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
BethGriggs
pushed a commit
that referenced
this pull request
Sep 21, 2021
PR-URL: #39984 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
listed server.listen() parameters
doc/api/http.md : listed server.listen() parameters