Browse Source

doc: path functions ignore trailing slashes

Add notes about path.parse(), path.basename() and path.dirname()
ignoring trailing slashes.

PR-URL: https://github.com/nodejs/node/pull/12181
Fixes: https://github.com/nodejs/node/issues/6229
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
v6.x
Tobias Nießen 8 years ago
committed by Myles Borins
parent
commit
a6e06738ef
No known key found for this signature in database GPG Key ID: 933B01F40B5CA946
  1. 18
      doc/api/path.md

18
doc/api/path.md

@ -64,7 +64,8 @@ added: v0.1.25
* Returns: {String}
The `path.basename()` methods returns the last portion of a `path`, similar to
the Unix `basename` command.
the Unix `basename` command. Trailing directory separators are ignored, see
[`path.sep`][].
For example:
@ -120,7 +121,8 @@ added: v0.1.16
* Returns: {String}
The `path.dirname()` method returns the directory name of a `path`, similar to
the Unix `dirname` command.
the Unix `dirname` command. Trailing directory separators are ignored, see
[`path.sep`][].
For example:
@ -335,7 +337,8 @@ added: v0.11.15
* Returns: {Object}
The `path.parse()` method returns an object whose properties represent
significant elements of the `path`.
significant elements of the `path`. Trailing directory separators are ignored,
see [`path.sep`][].
The returned object will have the following properties:
@ -506,6 +509,10 @@ On Windows:
// Returns: ['foo', 'bar', 'baz']
```
*Note*: On Windows, both the forward slash (`/`) and backward slash (`\`) are
accepted as path segment separators; however, the `path` methods only add
backward slashes (`\`).
## path.win32
<!-- YAML
added: v0.11.15
@ -516,11 +523,8 @@ 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.sep`]: #path_path_sep
[`path.win32`]: #path_path_win32
[`path.parse()`]: #path_path_parse_path
[`TypeError`]: errors.html#errors_class_typeerror

Loading…
Cancel
Save