fsPromises.rmdir(path[, options])
path
<string> | <Buffer> | <URL>options
<Object>maxRetries
<integer> 如果遇到EBUSY
、EMFILE
、ENFILE
、ENOTEMPTY
或EPERM
错误,Node.js 将在每次尝试时以retryDelay
毫秒的线性退避等待时间重试该操作。 此选项表示重试次数。 如果recursive
选项不为true
,则忽略此选项。 默认值:0
。recursive
<boolean> 如果为true
,则执行递归目录删除。 在递归模式下,操作将在失败时重试。 默认值:false
。 已弃用。retryDelay
<integer> 重试之间等待的时间(以毫秒为单位)。 如果recursive
选项不为true
,则忽略此选项。 默认值:100
。
- 返回: <Promise> 成功时将使用
undefined
履行。
删除由 path
标识的目录。
在文件(而不是目录)上使用 fsPromises.rmdir()
会导致 promise 被拒绝,在 Windows 上使用 ENOENT
错误,在 POSIX 上使用 ENOTDIR
错误。
要获得类似于 rm -rf
Unix 命令的行为,则使用具有选项 { recursive: true, force: true }
的 fsPromises.rm()
。
path
<string> | <Buffer> | <URL>options
<Object>maxRetries
<integer> If anEBUSY
,EMFILE
,ENFILE
,ENOTEMPTY
, orEPERM
error is encountered, Node.js retries the operation with a linear backoff wait ofretryDelay
milliseconds longer on each try. This option represents the number of retries. This option is ignored if therecursive
option is nottrue
. Default:0
.recursive
<boolean> Iftrue
, perform a recursive directory removal. In recursive mode, operations are retried on failure. Default:false
. Deprecated.retryDelay
<integer> The amount of time in milliseconds to wait between retries. This option is ignored if therecursive
option is nottrue
. Default:100
.
- Returns: <Promise> Fulfills with
undefined
upon success.
Removes the directory identified by path
.
Using fsPromises.rmdir()
on a file (not a directory) results in the
promise being rejected with an ENOENT
error on Windows and an ENOTDIR
error on POSIX.
To get a behavior similar to the rm -rf
Unix command, use
fsPromises.rm()
with options { recursive: true, force: true }
.