Skip to content

Commit

Permalink
doc: note that path.normalize deviates from POSIX
Browse files Browse the repository at this point in the history
  • Loading branch information
tniessen authored Jan 18, 2024
1 parent 32ce183 commit 6e4aa58
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions doc/api/path.md
Original file line number Diff line number Diff line change
Expand Up @@ -361,6 +361,13 @@ 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 6e4aa58

Please sign in to comment.