Skip to content

Commit c29f2f2

Browse files
towcjasnell
authored andcommitted
doc: added ready events to fs/streams,net/socket
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>
1 parent 9743e75 commit c29f2f2

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

doc/api/fs.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -363,6 +363,15 @@ added: v0.1.93
363363

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

366+
### Event: 'ready'
367+
<!-- YAML
368+
added: v9.11.0
369+
-->
370+
371+
Emitted when the `fs.ReadStream` is ready to be used.
372+
373+
Fires immediately after `'open'`.
374+
366375
### readStream.bytesRead
367376
<!-- YAML
368377
added: v6.4.0
@@ -678,6 +687,15 @@ added: v0.1.93
678687

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

690+
### Event: 'ready'
691+
<!-- YAML
692+
added: v9.11.0
693+
-->
694+
695+
Emitted when the `fs.WriteStream` is ready to be used.
696+
697+
Fires immediately after `'open'`.
698+
681699
### writeStream.bytesWritten
682700
<!-- YAML
683701
added: v0.4.7

doc/api/net.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -485,6 +485,15 @@ Not applicable to UNIX sockets.
485485
* `family` {string|null} The address type. See [`dns.lookup()`][].
486486
* `host` {string} The hostname.
487487

488+
### Event: 'ready'
489+
<!-- YAML
490+
added: v9.11.0
491+
-->
492+
493+
Emitted when a socket is ready to be used.
494+
495+
Triggered immediately after `'connect'`.
496+
488497
### Event: 'timeout'
489498
<!-- YAML
490499
added: v0.1.90

0 commit comments

Comments
 (0)