Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: Add windows example for Path.format #5700

Closed
wants to merge 3 commits into from
Closed

doc: Add windows example for Path.format #5700

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b33eee0
doc: Add windows example for Path.format
mithun-daa Mar 14, 2016
5250683
doc: Add windows example for Path.format
mithun-daa Mar 14, 2016
0b6b6aa
doc: Comment the return value for Path.format
mithun-daa Mar 21, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions doc/api/path.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,8 @@ and the `ext` property will be used as the `base` property.

Examples:

An example on Posix systems:

```js
path.format({
root : "/",
Expand All @@ -125,6 +127,19 @@ path.format({
// returns '/file.txt'
```

An example on Windows:

```js
path.format({
root : "C:\\",
dir : "C:\\path\\dir",
base : "file.txt",
ext : ".txt",
name : "file"
})
// returns 'C:\\path\\dir\\file.txt'
```

## path.isAbsolute(path)

Determines whether `path` is an absolute path. An absolute path will always
Expand Down