Skip to content
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.

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

doc/api: listed server.listen() parameters and made some minor corr… #39984

Closed
wants to merge 2 commits into from

Conversation

vi-kush
Copy link

@vi-kush vi-kush commented Sep 3, 2021

listed server.listen() parameters

doc/api/http.md : listed server.listen() parameters

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label 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])`.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
first directory path created, `(err [,path])`.
first directory path created, `(err[, path])`.

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])`
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
### `fs.readSync(fd, buffer [,options])`
### `fs.readSync(fd, buffer[, options])`

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])`
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
### `server.listen(Port [,host] [,callback])`
### `server.listen(port[, host[, callback]])`

doc/api/http.md Outdated
Comment on lines 1295 to 1297
* `Port` {Number}
* `Host` {String}
* `callback` {Function}
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
* `Port` {Number}
* `Host` {String}
* `callback` {Function}
* `port` {number}
* `host` {string}
* `callback` {Function}

@@ -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])`
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
### `stream.Readable.from(iterable [,options])`
### `stream.Readable.from(iterable[, options])`

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])`
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
### `server.listen(Port[, host][, callback])`
### `server.listen(port[, host][, callback])`

doc/api/http.md Outdated
### `server.listen()`
### `server.listen(Port[, host][, callback])`

* `Port` {number}
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* `Port` {number}
* `port` {number}

doc/api/http.md Outdated
### `server.listen(Port[, host][, callback])`

* `Port` {number}
* `Host` {string}
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* `Host` {string}
* `host` {string}

doc/api/http.md: listed server.listen() parameters
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])`
Copy link
Member

Choose a reason for hiding this comment

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

Please keep it as is. server.listen() has multiple signatures. See https://nodejs.org/api/net.html#net_server_listen.

@VoltrexKeyva VoltrexKeyva added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Sep 7, 2021
targos pushed a commit that referenced this pull request Sep 18, 2021
PR-URL: #39984
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@targos
Copy link
Member

targos commented Sep 18, 2021

Landed in f4292bc

@targos targos closed this Sep 18, 2021
BethGriggs pushed a commit that referenced this pull request Sep 21, 2021
PR-URL: #39984
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
BethGriggs pushed a commit that referenced this pull request Sep 21, 2021
PR-URL: #39984
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@BethGriggs BethGriggs mentioned this pull request Sep 21, 2021
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants