1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: path.format provide more examples

Browse Source 
This change was to add upon the algorithm description of path.format
by adding examples for unix systems that clarified behavior in
various scenarios.

PR-URL: https://github.com/nodejs/node/pull/5838
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Roman Klauke <romaaan.git@gmail.com>
This commit is contained in:
John Eversole 2016-03-21 18:20:16 -07:00 committed by James M Snell
parent eaab17c6a7
commit 820844d673
1 changed files with 27 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
doc/api/path.markdown
View File

@ -95,7 +95,7 @@ and the `base` property.
If the `dir` property is not supplied, the `root` property will be used as the If the `dir` property is not supplied, the `root` property will be used as the
`dir` property. However, it will be assumed that the `root` property already `dir` property. However, it will be assumed that the `root` property already
ends with the platform-dependent path separator. In this case, the returned ends with the platform-dependent path separator. In this case, the returned
string will be the concatenation fo the `root` property and the `base` property. string will be the concatenation of the `root` property and the `base` property.
If both the `dir` and the `root` properties are not supplied, then the returned If both the `dir` and the `root` properties are not supplied, then the returned
string will be the contents of the `base` property. string will be the contents of the `base` property.
@ -105,28 +105,41 @@ and the `ext` property will be used as the `base` property.
Examples: Examples:
An example on Posix systems: Some Posix system examples:
```js ```js
// If `dir` and `base` are provided, `dir` + platform separator + `base`
// will be returned.
path.format({ path.format({
root : "/", dir: '/home/user/dir',
dir : "/home/user/dir", base: 'file.txt'
base : "file.txt",
ext : ".txt",
name : "file"
}); });
// returns '/home/user/dir/file.txt' // returns '/home/user/dir/file.txt'
// `root` will be used if `dir` is not specified and `name` + `ext` will be used // `root` will be used if `dir` is not specified.
// if `base` is not specified // `name` + `ext` will be used if `base` is not specified.
// If only `root` is provided or `dir` is equal to `root` then the
// platform separator will not be included.
path.format({ path.format({
root : "/", root: '/',
ext : ".txt", base: 'file.txt'
name : "file" });
})
// returns '/file.txt' // returns '/file.txt'
```
path.format({
dir: '/',
root: '/',
name: 'file',
ext: '.txt'
});
// returns '/file.txt'
// `base` will be returned if `dir` or `root` are not provided.
path.format({
base: 'file.txt'
});
// returns 'file.txt'
```
An example on Windows: An example on Windows:
```js ```js