From e3f133a5f1e3258ce04259d766984c115b54ddd2 Mon Sep 17 00:00:00 2001 From: Matei Copot Date: Thu, 12 Apr 2018 10:11:51 +0200 Subject: [PATCH] doc: added ready events to fs/streams,net/socket PR-URL: https://github.com/nodejs/node/pull/19968 Fixes: https://github.com/nodejs/node/issues/19796 Reviewed-By: Matteo Collina Reviewed-By: Ruben Bridgewater Reviewed-By: Vse Mozhet Byt Reviewed-By: Colin Ihrig --- doc/api/fs.md | 18 ++++++++++++++++++ doc/api/net.md | 9 +++++++++ 2 files changed, 27 insertions(+) diff --git a/doc/api/fs.md b/doc/api/fs.md index 368193024628a1..63c07566c8917b 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -363,6 +363,15 @@ added: v0.1.93 Emitted when the `fs.ReadStream`'s file descriptor has been opened. +### Event: 'ready' + + +Emitted when the `fs.ReadStream` is ready to be used. + +Fires immediately after `'open'`. + ### readStream.bytesRead + +Emitted when the `fs.WriteStream` is ready to be used. + +Fires immediately after `'open'`. + ### writeStream.bytesWritten + +Emitted when a socket is ready to be used. + +Triggered immediately after `'connect'`. + ### Event: 'timeout'