Skip to content

Commit

Permalink
doc: clarify that path on windows accepts / and \
Browse files Browse the repository at this point in the history
Fixes: nodejs#6520
PR-URL: nodejs#8291
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
  • Loading branch information
jasnell authored and Fishrock123 committed Sep 8, 2016
1 parent dc9d5a7 commit 1645948
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions doc/api/path.md
Original file line number Diff line number Diff line change
Expand Up @@ -261,10 +261,13 @@ path.isAbsolute('.') // false
On Windows:

```js
path.isAbsolute('//server') // true
path.isAbsolute('C:/foo/..') // true
path.isAbsolute('bar\\baz') // false
path.isAbsolute('.') // false
path.isAbsolute('//server') // true
path.isAbsolute('\\\\server') // true
path.isAbsolute('C:/foo/..') // true
path.isAbsolute('C:\\foo\\..') // true
path.isAbsolute('bar\\baz') // false
path.isAbsolute('bar/baz') // false
path.isAbsolute('.') // false
```

A [`TypeError`][] is thrown if `path` is not a string.
Expand Down Expand Up @@ -509,6 +512,10 @@ added: v0.11.15
The `path.win32` property provides access to Windows-specific implementations
of the `path` methods.

*Note*: On Windows, both the forward slash (`/`) and backward slash (`\`)
characters are accepted as path delimiters; however, only the backward slash
(`\`) will be used in return values.

[`path.posix`]: #path_path_posix
[`path.win32`]: #path_path_win32
[`path.parse()`]: #path_path_parse_path
Expand Down

0 comments on commit 1645948

Please sign in to comment.