doc: Add windows example for Path.format

PR-URL: #5700 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]>
nodejs · Mar 21, 2016 · 54e6a8d · 54e6a8d
1 parent 8d39481
commit 54e6a8d
Showing 1 changed file with 15 additions and 0 deletions.
diff --git 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