function rmdir

Overload 1

#rmdir(path: PathLike,
callback: NoParamCallback,
): void

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.

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

#path: PathLike

#callback: NoParamCallback

void

#rmdir(path: PathLike,
options: RmDirOptions,
callback: NoParamCallback,
): void

#path: PathLike

#options: RmDirOptions

#callback: NoParamCallback

void