Skip to content

Commit

Permalink
doc/api: listed server.listen() parameters and made some minor corre…
Browse files Browse the repository at this point in the history
…ctions

  listed server.listen() optional paramenters that are used in examples but
  not documented and corrected some misleading commas.
   Changes :
    modified:  doc/api/fs.md : updated server.listen() and corrected commas
    modified:  doc/api/http.md : corrected commas
    modified:  doc/api/stream.md : corrected commas
  • Loading branch information
vipul kumar committed Sep 3, 2021
1 parent 0c35fe0 commit c0f4522
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 4 deletions.
4 changes: 2 additions & 2 deletions doc/api/fs.md
Expand Up @@ -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])`.
`path` can still be `undefined` when `recursive` is `true`, if no directory was
created.
Expand Down Expand Up @@ -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])`
<!-- YAML
added:
- v13.13.0
Expand Down
6 changes: 5 additions & 1 deletion doc/api/http.md
Expand Up @@ -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])`

* `Port` {Number}
* `Host` {String}
* `callback` {Function}

Starts the HTTP server listening for connections.
This method is identical to [`server.listen()`][] from [`net.Server`][].
Expand Down
2 changes: 1 addition & 1 deletion doc/api/stream.md
Expand Up @@ -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])`
<!-- YAML
added:
- v12.3.0
Expand Down

0 comments on commit c0f4522

Please sign in to comment.