fs.rmdirSync(path[, options])

版本历史
版本变更
v16.0.0

不再允许在作为文件的 path 上使用 fs.rmdirSync(path, { recursive: true })，这会在 Windows 上导致 ENOENT 错误，在 POSIX 上导致 ENOTDIR 错误。

v16.0.0

不再允许在不存在的 path 上使用 fs.rmdirSync(path, { recursive: true })，这会导致 ENOENT 错误。

v16.0.0

选项 recursive 已弃用，使用它会触发弃用警告。

v14.14.0

不推荐使用 recursive 选项，请改用 fs.rmSync。

v13.3.0, v12.16.0

选项 maxBusyTries 重命名为 maxRetries，默认值为 0。选项 emfileWait 已删除，并且 EMFILE 错误使用与其他错误相同的重试逻辑。现在支持 retryDelay 选项。现在重试 ENFILE 错误。

v12.10.0

现在支持 recursive、maxBusyTries 和 emfileWait 选项。

v7.6.0

参数 path 可以是使用 file: 协议的 WHATWG URL 对象。

v0.1.21

新增于: v0.1.21

  • path <string> | <Buffer> | <URL>

  • options <Object>

    • maxRetries <integer> 如果遇到 EBUSY、EMFILE、ENFILE、ENOTEMPTY 或 EPERM 错误，Node.js 将在每次尝试时以 retryDelay 毫秒的线性退避等待时间重试该操作。此选项表示重试次数。如果 recursive 选项不为 true，则忽略此选项。默认值：0。

      ¥maxRetries <integer> If an EBUSY, EMFILE, ENFILE, ENOTEMPTY, or EPERM error is encountered, Node.js retries the operation with a linear backoff wait of retryDelay milliseconds 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> 如果为 true，则执行递归目录删除。在递归模式下，操作将在失败时重试。默认值：false。已弃用。

      ¥recursive <boolean> If true, perform a recursive directory removal. In recursive mode, operations are retried on failure. Default: false. Deprecated.

    • retryDelay <integer> 重试之间等待的时间（以毫秒为单位）。如果 recursive 选项不为 true，则忽略此选项。默认值：100。

      ¥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.

同步 rmdir(2)。返回 undefined。

¥Synchronous rmdir(2). Returns undefined.

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

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

要获得类似于 rm -rf Unix 命令的行为，则使用具有选项 { recursive: true, force: true } 的 fs.rmSync()。

¥To get a behavior similar to the rm -rf Unix command, use fs.rmSync() with options { recursive: true, force: true }.