Commit d0d731e
doc: add descriptions about when options.mode is ignored
PR-URL: #39881
Fixes: #39859
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>1 parent 898db5a commit d0d731e
1 file changed
Lines changed: 18 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -613,6 +613,9 @@ exist. `data` can be a string or a {Buffer}. | |||
| 613 | 613 | ||
| 614 | 614 | If `options` is a string, then it specifies the `encoding`. | |
| 615 | 615 | ||
| 616 | + The `mode` option only affects the newly created file. See [`fs.open()`][] | ||
| 617 | + for more details. | ||
| 618 | + | ||
| 616 | 619 | The `path` may be specified as a {FileHandle} that has been opened | |
| 617 | 620 | for appending (using `fsPromises.open()`). | |
| 618 | 621 | ||
@@ -1283,6 +1286,9 @@ The `encoding` option is ignored if `data` is a buffer. | |||
| 1283 | 1286 | ||
| 1284 | 1287 | If `options` is a string, then it specifies the encoding. | |
| 1285 | 1288 | ||
| 1289 | + The `mode` option only affects the newly created file. See [`fs.open()`][] | ||
| 1290 | + for more details. | ||
| 1291 | + | ||
| 1286 | 1292 | Any specified {FileHandle} has to support writing. | |
| 1287 | 1293 | ||
| 1288 | 1294 | It is unsafe to use `fsPromises.writeFile()` multiple times on the same file | |
@@ -1548,6 +1554,9 @@ changes: | |||
| 1548 | 1554 | Asynchronously append data to a file, creating the file if it does not yet | |
| 1549 | 1555 | exist. `data` can be a string or a {Buffer}. | |
| 1550 | 1556 | ||
| 1557 | + The `mode` option only affects the newly created file. See [`fs.open()`][] | ||
| 1558 | + for more details. | ||
| 1559 | + | ||
| 1551 | 1560 | ```mjs | |
| 1552 | 1561 | import { appendFile } from 'fs'; | |
| 1553 | 1562 | ||
@@ -3915,6 +3924,9 @@ a file descriptor. | |||
| 3915 | 3924 | ||
| 3916 | 3925 | The `encoding` option is ignored if `data` is a buffer. | |
| 3917 | 3926 | ||
| 3927 | + The `mode` option only affects the newly created file. See [`fs.open()`][] | ||
| 3928 | + for more details. | ||
| 3929 | + | ||
| 3918 | 3930 | If `data` is a plain object, it must have an own (not inherited) `toString` | |
| 3919 | 3931 | function property. | |
| 3920 | 3932 | ||
@@ -4086,6 +4098,9 @@ changes: | |||
| 4086 | 4098 | Synchronously append data to a file, creating the file if it does not yet | |
| 4087 | 4099 | exist. `data` can be a string or a {Buffer}. | |
| 4088 | 4100 | ||
| 4101 | + The `mode` option only affects the newly created file. See [`fs.open()`][] | ||
| 4102 | + for more details. | ||
| 4103 | + | ||
| 4089 | 4104 | ```mjs | |
| 4090 | 4105 | import { appendFileSync } from 'fs'; | |
| 4091 | 4106 | ||
@@ -4999,6 +5014,9 @@ Returns `undefined`. | |||
| 4999 | 5014 | If `data` is a plain object, it must have an own (not inherited) `toString` | |
| 5000 | 5015 | function property. | |
| 5001 | 5016 | ||
| 5017 | + The `mode` option only affects the newly created file. See [`fs.open()`][] | ||
| 5018 | + for more details. | ||
| 5019 | + | ||
| 5002 | 5020 | For detailed information, see the documentation of the asynchronous version of | |
| 5003 | 5021 | this API: [`fs.writeFile()`][]. | |
| 5004 | 5022 | ||
0 commit comments