diff --git a/doc/api/path.md b/doc/api/path.md index a44bacb4657c10..9d1d4ce9176a4f 100644 --- a/doc/api/path.md +++ b/doc/api/path.md @@ -306,8 +306,9 @@ The `path.normalize()` method normalizes the given `path`, resolving `'..'` and `'.'` segments. When multiple, sequential path segment separation characters are found (e.g. -`/` on POSIX and `\` on Windows), they are replaced by a single instance of the -platform specific path segment separator. Trailing separators are preserved. +`/` on POSIX and either `\` or `/` on Windows), they are replaced by a single +instance of the platform specific path segment separator (`/` on POSIX and +`\` on Windows). Trailing separators are preserved. If the `path` is a zero-length string, `'.'` is returned, representing the current working directory. @@ -326,6 +327,14 @@ path.normalize('C:\\temp\\\\foo\\bar\\..\\'); // Returns: 'C:\\temp\\foo\\' ``` +Since Windows recognizes multiple path separators, both separators will be +replaced by instances of the Windows preferred separator (`\`): + +```js +path.win32.normalize('C:////temp\\\\/\\/\\/foo/bar'); +// Returns: 'C:\\temp\\foo\\bar' +``` + A [`TypeError`][] is thrown if `path` is not a string. ## path.parse(path)