Skip to content

Commit eaf4a19

Browse files
towcBridgeAR
authored andcommitted
doc: added ready events to fs/streams,net/socket
PR-URL: nodejs#19968 Fixes: nodejs#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 5bd6b91 commit eaf4a19

2 files changed

Lines changed: 27 additions & 0 deletions

File tree

doc/api/fs.md

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

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

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

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

691+
### Event: 'ready'
692+
<!-- YAML
693+
added: v9.11.0
694+
-->
695+
696+
Emitted when the `fs.WriteStream` is ready to be used.
697+
698+
Fires immediately after `'open'`.
699+
682700
### writeStream.bytesWritten
683701
<!-- YAML
684702
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)