Commit 2244a3c
doc: adds 'close' events to fs.ReadStream and fs.WriteStream
Add 'close' event to doc/api/fs.md --> fs.ReadStream
Add 'close' event to doc/api/fs.md --> fs.WriteStream
Add 'close event to doc/api/stream.md --> stream.Writable
From squashed history:
Add 'close' event to stream.Writable per Issue #6484
Add #### prefix to Event: 'close' and backticks to 'close'
similar to stream.Readable event: 'close' section
Add more specifics to 'close' events for fs.ReadStream
and fs.WriteStream
Fix/Changed 'close' event from 'fs.ReadStream' to 'fs.WriteStream'
wrapped long lines at 80 chars, reworded
per Issue #6484
including the 'close' event as optional
add 'close' event as optional in stream.Readable
per issue #6484
doc: Add 'close' events to fs.ReadStream, 80char nit
Fixes: #6484
PR-URL: #6499
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Brian White <mscdex@mscdex.net>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>1 parent 88f46b8 commit 2244a3c
2 files changed
Lines changed: 21 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -126,6 +126,11 @@ Stop watching for changes on the given `fs.FSWatcher`. | |||
| 126 | 126 | ||
| 127 | 127 | Emitted when the ReadStream's file is opened. | |
| 128 | 128 | ||
| 129 | + ### Event: 'close' | ||
| 130 | + | ||
| 131 | + Emitted when the `ReadStream`'s underlying file descriptor has been closed | ||
| 132 | + using the `fs.close()` method. | ||
| 133 | + | ||
| 129 | 134 | ### readStream.path | |
| 130 | 135 | ||
| 131 | 136 | The path to the file the stream is reading from. | |
@@ -210,6 +215,11 @@ on Unix systems, it never was. | |||
| 210 | 215 | ||
| 211 | 216 | Emitted when the WriteStream's file is opened. | |
| 212 | 217 | ||
| 218 | + ### Event: 'close' | ||
| 219 | + | ||
| 220 | + Emitted when the `WriteStream`'s underlying file descriptor has been closed | ||
| 221 | + using the `fs.close()` method. | ||
| 222 | + | ||
| 213 | 223 | ### writeStream.bytesWritten | |
| 214 | 224 | ||
| 215 | 225 | The number of bytes written so far. Does not include data that is still queued | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -160,7 +160,8 @@ Emitted when the stream and any of its underlying resources (a file | |||
| 160 | 160 | descriptor, for example) have been closed. The event indicates that | |
| 161 | 161 | no more events will be emitted, and no further computation will occur. | |
| 162 | 162 | ||
| 163 | - Not all streams will emit the `'close'` event. | ||
| 163 | + Not all streams will emit the `'close'` event as the `'close'` event is | ||
| 164 | + optional. | ||
| 164 | 165 | ||
| 165 | 166 | #### Event: 'data' | |
| 166 | 167 | ||
@@ -573,6 +574,15 @@ Examples of writable streams include: | |||
| 573 | 574 | * [child process stdin][] | |
| 574 | 575 | * [`process.stdout`][], [`process.stderr`][] | |
| 575 | 576 | ||
| 577 | + #### Event: 'close' | ||
| 578 | + | ||
| 579 | + Emitted when the stream and any of its underlying resources (a file descriptor, | ||
| 580 | + for example) have been closed. The event indicates that no more events will be | ||
| 581 | + emitted, and no further computation will occur. | ||
| 582 | + | ||
| 583 | + Not all streams will emit the `'close'` event as the `'close'` event is | ||
| 584 | + optional. | ||
| 585 | + | ||
| 576 | 586 | #### Event: 'drain' | |
| 577 | 587 | ||
| 578 | 588 | If a [`stream.write(chunk)`][stream-write] call returns `false`, then the | |
0 commit comments