From 060ac9b9f5a9c17fe7f2ce606159c78d7c8a755d Mon Sep 17 00:00:00 2001 From: Mithun Patel Date: Mon, 14 Mar 2016 10:50:50 -0500 Subject: [PATCH] doc: Add windows example for Path.format PR-URL: https://github.com/nodejs/node/pull/5700 Reviewed-By: James M Snell Reviewed-By: Sakthipriyan Vairamani --- doc/api/path.markdown | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/doc/api/path.markdown b/doc/api/path.markdown index 3d9fa5ba9b64c2..530dc440ca9f19 100644 --- a/doc/api/path.markdown +++ b/doc/api/path.markdown @@ -100,6 +100,10 @@ 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. +Examples: + +An example on Posix systems: + ```js path.format({ root : "/", @@ -120,6 +124,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