diff --git a/doc/api/path.markdown b/doc/api/path.markdown index f6df4cb58050c2..951527ba4ab4cd 100644 --- a/doc/api/path.markdown +++ b/doc/api/path.markdown @@ -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 : "/", @@ -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