1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: added ready events to fs/streams,net/socket

Browse Source 
PR-URL: https://github.com/nodejs/node/pull/19968
Fixes: https://github.com/nodejs/node/issues/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>
This commit is contained in:
Matei Copot 2018-04-12 10:11:51 +02:00 committed by Ruben Bridgewater
parent 2bee7996a5
commit e3f133a5f1
No known key found for this signature in database
GPG Key ID: F07496B3EB3C1762
2 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/api/fs.md
View File

@ -363,6 +363,15 @@ added: v0.1.93
Emitted when the `fs.ReadStream`'s file descriptor has been opened. 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 ### readStream.bytesRead
<!-- YAML <!-- YAML
added: v6.4.0 added: v6.4.0
@ -678,6 +687,15 @@ added: v0.1.93
Emitted when the `WriteStream`'s file is opened. 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 ### writeStream.bytesWritten
<!-- YAML <!-- YAML
added: v0.4.7 added: v0.4.7

9
doc/api/net.md
View File

@ -485,6 +485,15 @@ Not applicable to UNIX sockets.
* `family` {string|null} The address type. See [`dns.lookup()`][]. * `family` {string|null} The address type. See [`dns.lookup()`][].
* `host` {string} The hostname. * `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' ### Event: 'timeout'
<!-- YAML <!-- YAML
added: v0.1.90 added: v0.1.90