Commit f6a0343
docs: add note about fs.rmdir()
fs.rmdir() on the file (not directory) results in different errors on
Windows to everything else
Fixes: #8797
PR-URL: #14323
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>1 parent 3bc7d2a commit f6a0343
1 file changed
Lines changed: 6 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -2004,6 +2004,9 @@ changes: | |||
| 2004 | 2004 | Asynchronous rmdir(2). No arguments other than a possible exception are given | |
| 2005 | 2005 | to the completion callback. | |
| 2006 | 2006 | ||
| 2007 | + *Note*: Using `fs.rmdir()` on a file (not a directory) results in an `ENOENT` | ||
| 2008 | + error on Windows and an `ENOTDIR` error on POSIX. | ||
| 2009 | + | ||
| 2007 | 2010 | ## fs.rmdirSync(path) | |
| 2008 | 2011 | <!-- YAML | |
| 2009 | 2012 | added: v0.1.21 | |
@@ -2018,6 +2021,9 @@ changes: | |||
| 2018 | 2021 | ||
| 2019 | 2022 | Synchronous rmdir(2). Returns `undefined`. | |
| 2020 | 2023 | ||
| 2024 | + *Note*: Using `fs.rmdirSync()` on a file (not a directory) results in an `ENOENT` | ||
| 2025 | + error on Windows and an `ENOTDIR` error on POSIX. | ||
| 2026 | + | ||
| 2021 | 2027 | ## fs.stat(path, callback) | |
| 2022 | 2028 | <!-- YAML | |
| 2023 | 2029 | added: v0.0.2 | |
0 commit comments