From 86067f0129a7f0dc30ad867a5a50941ceb00263b Mon Sep 17 00:00:00 2001 From: James M Snell Date: Fri, 26 Aug 2016 20:36:48 -0700 Subject: [PATCH] doc: clarify that path on windows accepts / and \ Fixes: https://github.com/nodejs/node/issues/6520 PR-URL: https://github.com/nodejs/node/pull/8291 Reviewed-By: Luigi Pinca Reviewed-By: Anna Henningsen --- doc/api/path.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/doc/api/path.md b/doc/api/path.md index 6617f0e9e76b62..1067792631a3e7 100644 --- a/doc/api/path.md +++ b/doc/api/path.md @@ -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. @@ -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