Skip to content

Commit

Permalink
doc: path.format provide more examples
Browse files Browse the repository at this point in the history
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: #5838
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Roman Klauke <romaaan.git@gmail.com>
  • Loading branch information
eversojk authored and Myles Borins committed Apr 20, 2016
1 parent 9856b80 commit d66d883
Showing 1 changed file with 32 additions and 7 deletions.
39 changes: 32 additions & 7 deletions doc/api/path.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -92,25 +92,50 @@ and the `base` property.
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
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
string will be the contents of the `base` property.

If the `base` property is not supplied, a concatenation of the `name` property
and the `ext` property will be used as the `base` property.

An example on Posix systems:
Examples:

Some Posix system examples:

```js
// If `dir` and `base` are provided, `dir` + platform separator + `base`
// will be returned.
path.format({
root : "/",
dir : "/home/user/dir",
base : "file.txt",
ext : ".txt",
name : "file"
dir: '/home/user/dir',
base: 'file.txt'
});
// returns '/home/user/dir/file.txt'

// `root` will be used if `dir` 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({
root: '/',
base: '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:
Expand Down

0 comments on commit d66d883

Please sign in to comment.