Skip to content

Commit

Permalink
doc: note that path.normalize deviates from POSIX
Browse files Browse the repository at this point in the history
PR-URL: #51513
Refs: #51345
Reviewed-By: Yagiz Nizipli <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
  • Loading branch information
tniessen authored and richardlau committed Mar 25, 2024
1 parent e7d30d3 commit 33c8734
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions doc/api/path.md
Original file line number Diff line number Diff line change
Expand Up @@ -361,6 +361,14 @@ instance of the platform-specific path segment separator (`/` on POSIX and
If the `path` is a zero-length string, `'.'` is returned, representing the
current working directory.

On POSIX, the types of normalization applied by this function do not strictly
adhere to the POSIX specification. For example, this function will replace two
leading forward slashes with a single slash as if it was a regular absolute
path, whereas a few POSIX systems assign special meaning to paths beginning with
exactly two forward slashes. Similarly, other substitutions performed by this
function, such as removing `..` segments, may change how the underlying system
resolves the path.

For example, on POSIX:

```js
Expand Down

0 comments on commit 33c8734

Please sign in to comment.