Skip to content

Commit

Permalink
doc: added ready events to fs/streams,net/socket
Browse files Browse the repository at this point in the history
PR-URL: #19968
Fixes: #19796
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
  • Loading branch information
towc authored and jasnell committed Apr 16, 2018
1 parent 9743e75 commit c29f2f2
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 0 deletions.
18 changes: 18 additions & 0 deletions doc/api/fs.md
Original file line number Diff line number Diff line change
Expand Up @@ -363,6 +363,15 @@ added: v0.1.93

Emitted when the `fs.ReadStream`'s file descriptor has been opened.

### Event: 'ready'
<!-- YAML
added: v9.11.0
-->

Emitted when the `fs.ReadStream` is ready to be used.

Fires immediately after `'open'`.

### readStream.bytesRead
<!-- YAML
added: v6.4.0
Expand Down Expand Up @@ -678,6 +687,15 @@ added: v0.1.93

Emitted when the `WriteStream`'s file is opened.

### Event: 'ready'
<!-- YAML
added: v9.11.0
-->

Emitted when the `fs.WriteStream` is ready to be used.

Fires immediately after `'open'`.

### writeStream.bytesWritten
<!-- YAML
added: v0.4.7
Expand Down
9 changes: 9 additions & 0 deletions doc/api/net.md
Original file line number Diff line number Diff line change
Expand Up @@ -485,6 +485,15 @@ Not applicable to UNIX sockets.
* `family` {string|null} The address type. See [`dns.lookup()`][].
* `host` {string} The hostname.

### Event: 'ready'
<!-- YAML
added: v9.11.0
-->

Emitted when a socket is ready to be used.

Triggered immediately after `'connect'`.

### Event: 'timeout'
<!-- YAML
added: v0.1.90
Expand Down

0 comments on commit c29f2f2

Please sign in to comment.