function rmdir
Jump to headingrmdir(path: PathLike,options?: RmDirOptions,): Promise<void>
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 }
.
Parameters Jump to heading
Jump to headingpath: PathLike
optional
Jump to headingoptions: RmDirOptions
Return Type Jump to heading
Promise<void>
Fulfills with undefined
upon success.