Skip to content

Commit e7d2961

Browse files
committed
squash: revert bad changes from d963269
1 parent c4a848a commit e7d2961

File tree

1 file changed

+16
-40
lines changed

1 file changed

+16
-40
lines changed

doc/api/fs.md

Lines changed: 16 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -174,14 +174,6 @@ helping to prevent memory leaks. Please do not rely on this behavior because
174174
it can be unreliable and the file may not be closed. Instead, always explicitly
175175
close {FileHandle}s. Node.js may change this behavior in the future.
176176

177-
#### Event: `'close'`
178-
<!-- YAML
179-
added: v15.4.0
180-
-->
181-
182-
The `'close'` event is emitted when the {FileHandle} has been closed and can no
183-
longer be used.
184-
185177
#### `filehandle.appendFile(data[, options])`
186178
<!-- YAML
187179
added: v10.0.0
@@ -334,9 +326,7 @@ of the file.
334326
335327
#### `filehandle.readv(buffers[, position])`
336328
<!-- YAML
337-
added:
338-
- v13.13.0
339-
- v12.17.0
329+
added: v14.0.0
340330
-->
341331
342332
* `buffers` {Buffer[]|TypedArray[]|DataView[]}
@@ -940,7 +930,7 @@ try {
940930
<!-- YAML
941931
added: v10.0.0
942932
changes:
943-
- version: v15.2.0
933+
- version: v14.17.0
944934
pr-url: https://github.com/nodejs/node/pull/35911
945935
description: The options argument may include an AbortSignal to abort an
946936
ongoing readFile request.
@@ -1193,7 +1183,7 @@ The `atime` and `mtime` arguments follow these rules:
11931183
<!-- YAML
11941184
added: v10.0.0
11951185
changes:
1196-
- version: v15.2.0
1186+
- version: v14.17.0
11971187
pr-url: https://github.com/nodejs/node/pull/35993
11981188
description: The options argument may include an AbortSignal to abort an
11991189
ongoing writeFile request.
@@ -1650,7 +1640,7 @@ See the POSIX chown(2) documentation for more detail.
16501640
<!-- YAML
16511641
added: v0.0.2
16521642
changes:
1653-
- version: REPLACEME
1643+
- version: v14.17.0
16541644
pr-url: https://github.com/nodejs/node/pull/37174
16551645
description: A default callback is now used if one is not provided.
16561646
- version: v10.0.0
@@ -1729,10 +1719,6 @@ copyFile('source.txt', 'destination.txt', constants.COPYFILE_EXCL, callback);
17291719
<!-- YAML
17301720
added: v0.1.31
17311721
changes:
1732-
- version:
1733-
- v15.4.0
1734-
pr-url: https://github.com/nodejs/node/pull/35922
1735-
description: The `fd` option accepts FileHandle arguments.
17361722
- version: v14.0.0
17371723
pr-url: https://github.com/nodejs/node/pull/31408
17381724
description: Change `emitClose` default to `true`.
@@ -1767,7 +1753,7 @@ changes:
17671753
* `flags` {string} See [support of file system `flags`][]. **Default:**
17681754
`'r'`.
17691755
* `encoding` {string} **Default:** `null`
1770-
* `fd` {integer|FileHandle} **Default:** `null`
1756+
* `fd` {integer} **Default:** `null`
17711757
* `mode` {integer} **Default:** `0o666`
17721758
* `autoClose` {boolean} **Default:** `true`
17731759
* `emitClose` {boolean} **Default:** `true`
@@ -1846,10 +1832,6 @@ If `options` is a string, then it specifies the encoding.
18461832
<!-- YAML
18471833
added: v0.1.31
18481834
changes:
1849-
- version:
1850-
- v15.4.0
1851-
pr-url: https://github.com/nodejs/node/pull/35922
1852-
description: The `fd` option accepts FileHandle arguments.
18531835
- version: v14.0.0
18541836
pr-url: https://github.com/nodejs/node/pull/31408
18551837
description: Change `emitClose` default to `true`.
@@ -1882,7 +1864,7 @@ changes:
18821864
* `flags` {string} See [support of file system `flags`][]. **Default:**
18831865
`'w'`.
18841866
* `encoding` {string} **Default:** `'utf8'`
1885-
* `fd` {integer|FileHandle} **Default:** `null`
1867+
* `fd` {integer} **Default:** `null`
18861868
* `mode` {integer} **Default:** `0o666`
18871869
* `autoClose` {boolean} **Default:** `true`
18881870
* `emitClose` {boolean} **Default:** `true`
@@ -2756,7 +2738,7 @@ If `options.withFileTypes` is set to `true`, the `files` array will contain
27562738
<!-- YAML
27572739
added: v0.1.29
27582740
changes:
2759-
- version: v15.2.0
2741+
- version: v14.17.0
27602742
pr-url: https://github.com/nodejs/node/pull/35911
27612743
description: The options argument may include an AbortSignal to abort an
27622744
ongoing readFile request.
@@ -3459,7 +3441,7 @@ The `atime` and `mtime` arguments follow these rules:
34593441
<!-- YAML
34603442
added: v0.5.10
34613443
changes:
3462-
- version: REPLACEME
3444+
- version: v14.17.0
34633445
pr-url: https://github.com/nodejs/node/pull/37190
34643446
description: Added support for closing the watcher with an AbortSignal.
34653447
- version: v7.6.0
@@ -3534,11 +3516,11 @@ to be notified of filesystem changes.
35343516
directories.
35353517
* On SunOS systems (including Solaris and SmartOS), this uses [`event ports`][].
35363518
* On Windows systems, this feature depends on [`ReadDirectoryChangesW`][].
3537-
* On Aix systems, this feature depends on [`AHAFS`][], which must be enabled.
3519+
* On AIX systems, this feature depends on [`AHAFS`][], which must be enabled.
35383520
* On IBM i systems, this feature is not supported.
35393521

35403522
If the underlying functionality is not available for some reason, then
3541-
`fs.watch()` will not be able to function and may thrown an exception.
3523+
`fs.watch()` will not be able to function and may throw an exception.
35423524
For example, watching files or directories can be unreliable, and in some
35433525
cases impossible, on network file systems (NFS, SMB, etc) or host file systems
35443526
when using virtualization software such as Vagrant or Docker.
@@ -3784,7 +3766,7 @@ details.
37843766
<!-- YAML
37853767
added: v0.1.29
37863768
changes:
3787-
- version: v15.2.0
3769+
- version: v14.17.0
37883770
pr-url: https://github.com/nodejs/node/pull/35993
37893771
description: The options argument may include an AbortSignal to abort an
37903772
ongoing writeFile request.
@@ -4331,7 +4313,7 @@ link(2) documentation for more detail. Returns `undefined`.
43314313
<!-- YAML
43324314
added: v0.1.30
43334315
changes:
4334-
- version: v15.3.0
4316+
- version: v14.17.0
43354317
pr-url: https://github.com/nodejs/node/pull/33716
43364318
description: Accepts a `throwIfNoEntry` option to specify whether
43374319
an exception should be thrown if the entry does not exist.
@@ -4584,13 +4566,9 @@ this API: [`fs.read()`][].
45844566
45854567
### `fs.readSync(fd, buffer, [options])`
45864568
<!-- YAML
4587-
added:
4588-
- v13.13.0
4589-
- v12.17.0
4569+
added: v14.0.0
45904570
changes:
4591-
- version:
4592-
- v13.13.0
4593-
- v12.17.0
4571+
- version: v14.0.0
45944572
pr-url: https://github.com/nodejs/node/pull/32460
45954573
description: Options object can be passed in
45964574
to make offset, length and position optional.
@@ -4614,9 +4592,7 @@ this API: [`fs.read()`][].
46144592
46154593
### `fs.readvSync(fd, buffers[, position])`
46164594
<!-- YAML
4617-
added:
4618-
- v13.13.0
4619-
- v12.17.0
4595+
added: v14.0.0
46204596
-->
46214597
46224598
* `fd` {integer}
@@ -4773,7 +4749,7 @@ utility). Returns `undefined`.
47734749
<!-- YAML
47744750
added: v0.1.21
47754751
changes:
4776-
- version: v15.3.0
4752+
- version: v14.17.0
47774753
pr-url: https://github.com/nodejs/node/pull/33716
47784754
description: Accepts a `throwIfNoEntry` option to specify whether
47794755
an exception should be thrown if the entry does not exist.

0 commit comments

Comments
 (0)