Skip to content

Commit

Permalink
doc: document rmdir/recursive deprecation
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
bcoe authored and MylesBorins committed Oct 14, 2020
1 parent 9d1b7ac commit 809cd07
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions doc/api/deprecations.md
Original file line number Diff line number Diff line change
Expand Up @@ -2628,6 +2628,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
Expand Down

0 comments on commit 809cd07

Please sign in to comment.