Skip to content

Commit

Permalink
Document the return value of ensureDir
Browse files Browse the repository at this point in the history
This feature is implemented in mkdirp and verified in the mkdirp tests. Just adding it to documentation.
  • Loading branch information
loilo authored Feb 17, 2017
1 parent 108b88a commit fd5c7cc
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/ensureDir.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,18 @@ fs.ensureDir(dir, function (err) {
// dir has now been created, including the directory it is to be placed in
})
```

---

The callback receives a second argument, containing the path to the first directory that was created in the process. If no directories were made, this will be `null`.
```js
var fs = require('fs-extra')

// Let's assume that /var/www exists

var dir = '/var/www/this/path/does/not/exist'
fs.ensureDir(dir, function (err, created) {
console.log(created) // => /var/www/this
// second argument contains the first directory in the path that did not exist before
})
```

0 comments on commit fd5c7cc

Please sign in to comment.