diff options
| author | bcoe <bencoe@google.com> | 2020-10-10 00:56:56 +0300 |
|---|---|---|
| committer | Benjamin Coe <bencoe@google.com> | 2020-10-12 19:42:15 +0300 |
| commit | c75928136f7c6aec773fe98227b90935f9ff7fca (patch) | |
| tree | 59b91253eac08e4fc7c74a119df9d7483e1aac39 /doc/api/deprecations.md | |
| parent | bb62f4ad9e10007734c737c85df718eafa626503 (diff) | |
doc: document rmdir/recursive deprecation
Document deprecation of rmdir/recursive permissive functionality
PR-URL: https://github.com/nodejs/node/pull/35579
Refs: https://github.com/nodejs/node/pull/35562
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Diffstat (limited to 'doc/api/deprecations.md')
| -rw-r--r-- | doc/api/deprecations.md | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md index bc693fe561c..0b1b8c5fa23 100644 --- a/doc/api/deprecations.md +++ b/doc/api/deprecations.md @@ -2655,6 +2655,20 @@ Type: Documentation-only The [`crypto.Certificate()` constructor][] is deprecated. Use [static methods of `crypto.Certificate()`][] instead. +### DEP0XXX: `fs.rmdir(path, { recursive: true })` +<!-- YAML +changes: + - version: REPLACME + pr-url: https://github.com/nodejs/node/pull/35579 + description: Documentation-only deprecation. +--> + +Type: Documentation-only + +In future versions of Node.js, `fs.rmdir(path, { recursive: true })` will throw +on nonexistent paths, or when given a file as a target. +Use `fs.rm(path, { recursive: true, force: true })` instead. + [Legacy URL API]: url.md#url_legacy_url_api [NIST SP 800-38D]: https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf [RFC 6066]: https://tools.ietf.org/html/rfc6066#section-3 |