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

Document the return value of ensureDir #359

Closed
wants to merge 1 commit into from
Closed

Document the return value of ensureDir #359

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 docs/ensureDir.md
View file
Open in desktop
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
})
```