fs.rmdir(path[, options], callback)

版本历史

版本	变更
v12.16.0	选项 `maxBusyTries` 重命名为 `maxRetries`，默认值为 0。选项 `emfileWait` 已删除，并且 `EMFILE` 错误使用与其他错误相同的重试逻辑。现在支持 `retryDelay` 选项。现在重试 `ENFILE` 错误。
v12.10.0	现在支持 `recursive`、`maxBusyTries` 和 `emfileWait` 选项。
v10.0.0	参数 `callback` 不再是可选的。不传入它会在运行时抛出 `TypeError`。
v7.6.0	参数 `path` 可以是使用 `file:` 协议的 WHATWG `URL` 对象。支持目前仍处于实验阶段。
v7.0.0	参数 `callback` 不再是可选的。不传入它将触发 ID 为 DEP0013 的弃用警告。
v0.0.2	新增于: v0.0.2

稳定性: 1 - Recursive removal 是实验的。

path <string> | <Buffer> | <URL>
options <Object>
- maxRetries <integer> 此选项表示重试次数。如果 recursive 选项不为 true，则忽略此选项。 默认值: 0。
- recursive <boolean> 如果为 true，则执行递归目录删除。在递归模式下，当 path 不存在时不报错，当操作失败时则重试。 默认值: false。
- retryDelay <integer> 重试之间等待的时间（以毫秒为单位）。如果 recursive 选项不为 true，则忽略此选项。 默认值: 100。
callback <Function>
- err <Error>

异步的 rmdir(2)。除了可能的异常之外，没有为完成回调提供任何参数。

在文件（而不是目录）上使用 fs.rmdir()，则在 Windows 上会导致 ENOENT 错误，在 POSIX 上会导致 ENOTDIR 错误。

History

Version	Changes
v12.16.0	The `maxBusyTries` option is renamed to `maxRetries`, and its default is 0. The `emfileWait` option has been removed, and `EMFILE` errors use the same retry logic as other errors. The `retryDelay` option is now supported. `ENFILE` errors are now retried.
v12.10.0	The `recursive`, `maxBusyTries`, and `emfileWait` options are now supported.
v10.0.0	The `callback` parameter is no longer optional. Not passing it will throw a `TypeError` at runtime.
v7.6.0	The `path` parameters can be a WHATWG `URL` object using `file:` protocol. Support is currently still experimental.
v7.0.0	The `callback` parameter is no longer optional. Not passing it will emit a deprecation warning with id DEP0013.
v0.0.2	Added in: v0.0.2

Stability: 1 - Recursive removal is experimental.

path <string> | <Buffer> | <URL>
options <Object>
- maxRetries <integer> If an EBUSY, EMFILE, ENFILE, ENOTEMPTY, or EPERM error is encountered, Node.js will retry the operation with a linear backoff wait of retryDelay ms longer on each try. This option represents the number of retries. This option is ignored if the recursive option is not true. Default: 0.
- recursive <boolean> If true, perform a recursive directory removal. In recursive mode, errors are not reported if path does not exist, and operations are retried on failure. Default: false.
- retryDelay <integer> The amount of time in milliseconds to wait between retries. This option is ignored if the recursive option is not true. Default: 100.
callback <Function>
- err <Error>

Asynchronous rmdir(2). No arguments other than a possible exception are given to the completion callback.

Using fs.rmdir() on a file (not a directory) results in an ENOENT error on Windows and an ENOTDIR error on POSIX.