Commit 809cd07
doc: document rmdir/recursive deprecation
Document deprecation of rmdir/recursive permissive functionality
PR-URL: #35579
Refs: #35562
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>1 parent 9d1b7ac commit 809cd07
1 file changed
Lines changed: 14 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -2628,6 +2628,20 @@ Type: Documentation-only | |||
| 2628 | 2628 | The [`crypto.Certificate()` constructor][] is deprecated. Use | |
| 2629 | 2629 | [static methods of `crypto.Certificate()`][] instead. | |
| 2630 | 2630 | ||
| 2631 | + ### DEP0XXX: `fs.rmdir(path, { recursive: true })` | ||
| 2632 | + <!-- YAML | ||
| 2633 | + changes: | ||
| 2634 | + - version: REPLACME | ||
| 2635 | + pr-url: https://github.com/nodejs/node/pull/35579 | ||
| 2636 | + description: Documentation-only deprecation. | ||
| 2637 | + --> | ||
| 2638 | + | ||
| 2639 | + Type: Documentation-only | ||
| 2640 | + | ||
| 2641 | + In future versions of Node.js, `fs.rmdir(path, { recursive: true })` will throw | ||
| 2642 | + on nonexistent paths, or when given a file as a target. | ||
| 2643 | + Use `fs.rm(path, { recursive: true, force: true })` instead. | ||
| 2644 | + | ||
| 2631 | 2645 | [Legacy URL API]: url.md#url_legacy_url_api | |
| 2632 | 2646 | [NIST SP 800-38D]: https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf | |
| 2633 | 2647 | [RFC 6066]: https://tools.ietf.org/html/rfc6066#section-3 | |
0 commit comments