Commit 298a16a
doc: update emitClose default for fs streams
The default for the `emitClose` option was changed from `false` to
`true` by #31408 which landed in f0d2df4 for v14.0.0.
This commit updates the fs doc to match the current behavior.
Signed-off-by: Kevin Locke <kevin@kevinlocke.name>
PR-URL: #36653
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Robert Nagy <ronagy@icloud.com>1 parent 4a88dde commit 298a16a
1 file changed
Lines changed: 14 additions & 8 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1758,6 +1758,9 @@ fs.copyFileSync('source.txt', 'destination.txt', COPYFILE_EXCL); | |||
| 1758 | 1758 | <!-- YAML | |
| 1759 | 1759 | added: v0.1.31 | |
| 1760 | 1760 | changes: | |
| 1761 | + - version: v14.0.0 | ||
| 1762 | + pr-url: https://github.com/nodejs/node/pull/31408 | ||
| 1763 | + description: Change `emitClose` default to `true`. | ||
| 1761 | 1764 | - version: v13.6.0 | |
| 1762 | 1765 | pr-url: https://github.com/nodejs/node/pull/29083 | |
| 1763 | 1766 | description: The `fs` options allow overriding the used `fs` | |
@@ -1790,7 +1793,7 @@ changes: | |||
| 1790 | 1793 | * `fd` {integer} **Default:** `null` | |
| 1791 | 1794 | * `mode` {integer} **Default:** `0o666` | |
| 1792 | 1795 | * `autoClose` {boolean} **Default:** `true` | |
| 1793 | - * `emitClose` {boolean} **Default:** `false` | ||
| 1796 | + * `emitClose` {boolean} **Default:** `true` | ||
| 1794 | 1797 | * `start` {integer} | |
| 1795 | 1798 | * `end` {integer} **Default:** `Infinity` | |
| 1796 | 1799 | * `highWaterMark` {integer} **Default:** `64 * 1024` | |
@@ -1818,9 +1821,9 @@ If `fd` points to a character device that only supports blocking reads | |||
| 1818 | 1821 | available. This can prevent the process from exiting and the stream from | |
| 1819 | 1822 | closing naturally. | |
| 1820 | 1823 | ||
| 1821 | - By default, the stream will not emit a `'close'` event after it has been | ||
| 1822 | - destroyed. This is the opposite of the default for other `Readable` streams. | ||
| 1823 | - Set the `emitClose` option to `true` to change this behavior. | ||
| 1824 | + By default, the stream will emit a `'close'` event after it has been | ||
| 1825 | + destroyed, like most `Readable` streams. Set the `emitClose` option to | ||
| 1826 | + `false` to change this behavior. | ||
| 1824 | 1827 | ||
| 1825 | 1828 | By providing the `fs` option, it is possible to override the corresponding `fs` | |
| 1826 | 1829 | implementations for `open`, `read`, and `close`. When providing the `fs` option, | |
@@ -1863,6 +1866,9 @@ If `options` is a string, then it specifies the encoding. | |||
| 1863 | 1866 | <!-- YAML | |
| 1864 | 1867 | added: v0.1.31 | |
| 1865 | 1868 | changes: | |
| 1869 | + - version: v14.0.0 | ||
| 1870 | + pr-url: https://github.com/nodejs/node/pull/31408 | ||
| 1871 | + description: Change `emitClose` default to `true`. | ||
| 1866 | 1872 | - version: v13.6.0 | |
| 1867 | 1873 | pr-url: https://github.com/nodejs/node/pull/29083 | |
| 1868 | 1874 | description: The `fs` options allow overriding the used `fs` | |
@@ -1893,7 +1899,7 @@ changes: | |||
| 1893 | 1899 | * `fd` {integer} **Default:** `null` | |
| 1894 | 1900 | * `mode` {integer} **Default:** `0o666` | |
| 1895 | 1901 | * `autoClose` {boolean} **Default:** `true` | |
| 1896 | - * `emitClose` {boolean} **Default:** `false` | ||
| 1902 | + * `emitClose` {boolean} **Default:** `true` | ||
| 1897 | 1903 | * `start` {integer} | |
| 1898 | 1904 | * `fs` {Object|null} **Default:** `null` | |
| 1899 | 1905 | * Returns: {fs.WriteStream} See [Writable Stream][]. | |
@@ -1910,9 +1916,9 @@ then the file descriptor won't be closed, even if there's an error. | |||
| 1910 | 1916 | It is the application's responsibility to close it and make sure there's no | |
| 1911 | 1917 | file descriptor leak. | |
| 1912 | 1918 | ||
| 1913 | - By default, the stream will not emit a `'close'` event after it has been | ||
| 1914 | - destroyed. This is the opposite of the default for other `Writable` streams. | ||
| 1915 | - Set the `emitClose` option to `true` to change this behavior. | ||
| 1919 | + By default, the stream will emit a `'close'` event after it has been | ||
| 1920 | + destroyed, like most `Writable` streams. Set the `emitClose` option to | ||
| 1921 | + `false` to change this behavior. | ||
| 1916 | 1922 | ||
| 1917 | 1923 | By providing the `fs` option it is possible to override the corresponding `fs` | |
| 1918 | 1924 | implementations for `open`, `write`, `writev` and `close`. Overriding `write()` | |
0 commit comments