doc: add note about path.basename on Windows

PR-URL: #35065 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Gerhard Stöbich <[email protected]> Reviewed-By: Rich Trott <[email protected]>
nodejs · Sep 22, 2020 · 3954b8f · 3954b8f
1 parent d60c487
commit 3954b8f
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/doc/api/path.md b/doc/api/path.md
@@ -87,6 +87,19 @@ path.basename('/foo/bar/baz/asdf/quux.html', '.html');
 // Returns: 'quux'
 ```
 
+Although Windows usually treats file names, including file extensions, in a
+case-insensitive manner, this function does not. For example, `C:\\foo.html` and
+`C:\\foo.HTML` refer to the same file, but `basename` treats the extension as a
+case-sensitive string:
+
+```js
+path.win32.basename('C:\\foo.html', '.html');
+// Returns: 'foo'
+
+path.win32.basename('C:\\foo.HTML', '.html');
+// Returns: 'foo.HTML'
+```
+
 A [`TypeError`][] is thrown if `path` is not a string or if `ext` is given
 and is not a string.