diff options
| author | bcoe <bencoe@google.com> | 2020-10-02 00:40:50 +0300 |
|---|---|---|
| committer | Danielle Adams <adamzdanielle@gmail.com> | 2020-10-06 19:16:05 +0300 |
| commit | fcbdb0686d9c20cecb8ab70ac6bad04fb8b23070 (patch) | |
| tree | 64cddd9afd419f1a42c5d3ec5c7f78fcd2f9ee05 /doc | |
| parent | 862b75d35e2c46b23d0c4235c35a2d162c856735 (diff) | |
fs: remove experimental from rmdir recursive
Refs: https://github.com/nodejs/node/issues/34278
PR-URL: https://github.com/nodejs/node/pull/35171
Reviewed-By: Christopher Hiller <boneskull@boneskull.com>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/fs.md | 22 |
1 files changed, 18 insertions, 4 deletions
diff --git a/doc/api/fs.md b/doc/api/fs.md index 44dbb83247f..72357443ece 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -3502,8 +3502,6 @@ changes: it will emit a deprecation warning with id DEP0013. --> -> Stability: 1 - Recursive removal is experimental. - * `path` {string|Buffer|URL} * `options` {Object} * `maxRetries` {integer} If an `EBUSY`, `EMFILE`, `ENFILE`, `ENOTEMPTY`, or @@ -3526,6 +3524,12 @@ to the completion callback. Using `fs.rmdir()` on a file (not a directory) results in an `ENOENT` error on Windows and an `ENOTDIR` error on POSIX. +Setting `recursive` to `true` results in behavior similar to the Unix command +`rm -rf`: an error will not be raised for paths that do not exist, and paths +that represent files will be deleted. The permissive behavior of the +`recursive` option is deprecated, `ENOTDIR` and `ENOENT` will be thrown in +the future. + ## `fs.rmdirSync(path[, options])` <!-- YAML added: v0.1.21 @@ -3549,8 +3553,6 @@ changes: `file:` protocol. Support is currently still *experimental*. --> -> Stability: 1 - Recursive removal is experimental. - * `path` {string|Buffer|URL} * `options` {Object} * `maxRetries` {integer} If an `EBUSY`, `EMFILE`, `ENFILE`, `ENOTEMPTY`, or @@ -3570,6 +3572,12 @@ Synchronous rmdir(2). Returns `undefined`. Using `fs.rmdirSync()` on a file (not a directory) results in an `ENOENT` error on Windows and an `ENOTDIR` error on POSIX. +Setting `recursive` to `true` results in behavior similar to the Unix command +`rm -rf`: an error will not be raised for paths that do not exist, and paths +that represent files will be deleted. The permissive behavior of the +`recursive` option is deprecated, `ENOTDIR` and `ENOENT` will be thrown in +the future. + ## `fs.stat(path[, options], callback)` <!-- YAML added: v0.0.2 @@ -5451,6 +5459,12 @@ Using `fsPromises.rmdir()` on a file (not a directory) results in the `Promise` being rejected with an `ENOENT` error on Windows and an `ENOTDIR` error on POSIX. +Setting `recursive` to `true` results in behavior similar to the Unix command +`rm -rf`: an error will not be raised for paths that do not exist, and paths +that represent files will be deleted. The permissive behavior of the +`recursive` option is deprecated, `ENOTDIR` and `ENOENT` will be thrown in +the future. + ### `fsPromises.stat(path[, options])` <!-- YAML added: v10.0.0 |