mirror of
https://github.com/jprichardson/node-fs-extra.git
synced 2026-01-18 16:13:55 +00:00
* improve docs * Update docs/ensureSymlink-sync.md Co-authored-by: Ryan Zimmerman <17342435+RyanZim@users.noreply.github.com> * Update docs/ensureSymlink.md Co-authored-by: Ryan Zimmerman <17342435+RyanZim@users.noreply.github.com> * add Error type to docs Co-authored-by: Ryan Zimmerman <17342435+RyanZim@users.noreply.github.com>
44 lines
848 B
Markdown
44 lines
848 B
Markdown
# emptyDir(dir[, callback])
|
|
|
|
Ensures that a directory is empty. Deletes directory contents if the directory is not empty. If the directory does not exist, it is created. The directory itself is not deleted.
|
|
|
|
**Alias:** `emptydir()`
|
|
|
|
- `dir` `<String>`
|
|
- `callback` `<Function>`
|
|
- `err` `<Error>`
|
|
|
|
## Example:
|
|
|
|
```js
|
|
const fs = require('fs-extra')
|
|
|
|
// assume this directory has a lot of files and folders
|
|
// With a callback:
|
|
fs.emptyDir('/tmp/some/dir', err => {
|
|
if (err) return console.error(err)
|
|
console.log('success!')
|
|
})
|
|
|
|
// With Promises:
|
|
fs.emptyDir('/tmp/some/dir')
|
|
.then(() => {
|
|
console.log('success!')
|
|
})
|
|
.catch(err => {
|
|
console.error(err)
|
|
})
|
|
|
|
// With async/await:
|
|
async function example () {
|
|
try {
|
|
await fs.emptyDir('/tmp/some/dir')
|
|
console.log('success!')
|
|
} catch (err) {
|
|
console.error(err)
|
|
}
|
|
}
|
|
|
|
example()
|
|
```
|