diff --git a/doc/api/fs.md b/doc/api/fs.md index f480c29eb1..895d5c5e93 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -151,6 +151,11 @@ Stop watching for changes on the given `fs.FSWatcher`. Emitted when the ReadStream's file is opened. +### Event: 'close' + +Emitted when the `ReadStream`'s underlying file descriptor has been closed +using the `fs.close()` method. + ### readStream.path The path to the file the stream is reading from as specified in the first @@ -238,6 +243,11 @@ on Unix systems, it never was. Emitted when the WriteStream's file is opened. +### Event: 'close' + +Emitted when the `WriteStream`'s underlying file descriptor has been closed +using the `fs.close()` method. + ### writeStream.bytesWritten The number of bytes written so far. Does not include data that is still queued diff --git a/doc/api/stream.md b/doc/api/stream.md index a7478bf3de..9a981288f1 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -160,7 +160,8 @@ Emitted when the stream and any of its underlying resources (a file descriptor, for example) have been closed. The event indicates that no more events will be emitted, and no further computation will occur. -Not all streams will emit the `'close'` event. +Not all streams will emit the `'close'` event as the `'close'` event is +optional. #### Event: 'data' @@ -573,6 +574,15 @@ Examples of writable streams include: * [child process stdin][] * [`process.stdout`][], [`process.stderr`][] +#### Event: 'close' + +Emitted when the stream and any of its underlying resources (a file descriptor, +for example) have been closed. The event indicates that no more events will be +emitted, and no further computation will occur. + +Not all streams will emit the `'close'` event as the `'close'` event is +optional. + #### Event: 'drain' If a [`stream.write(chunk)`][stream-write] call returns `false`, then the