Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: document rmdir/recursive deprecation #35579

Closed
wants to merge 5 commits into from
Closed
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 14 additions & 0 deletions doc/api/deprecations.md
Expand Up @@ -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/35562
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