Skip to content

Commit 809cd07

Browse files
bcoeMylesBorins
authored andcommitted
doc: document rmdir/recursive deprecation
Document deprecation of rmdir/recursive permissive functionality PR-URL: #35579 Refs: #35562 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Michaël Zasso <[email protected]>
1 parent 9d1b7ac commit 809cd07

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

doc/api/deprecations.md

+14
Original file line numberDiff line numberDiff line change
@@ -2628,6 +2628,20 @@ Type: Documentation-only
26282628
The [`crypto.Certificate()` constructor][] is deprecated. Use
26292629
[static methods of `crypto.Certificate()`][] instead.
26302630

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+
26312645
[Legacy URL API]: url.md#url_legacy_url_api
26322646
[NIST SP 800-38D]: https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf
26332647
[RFC 6066]: https://tools.ietf.org/html/rfc6066#section-3

0 commit comments

Comments
 (0)