aboutsummaryrefslogtreecommitdiff
path: root/node_modules/fs-extra/docs/ensureDir.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/fs-extra/docs/ensureDir.md')
-rw-r--r--node_modules/fs-extra/docs/ensureDir.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/node_modules/fs-extra/docs/ensureDir.md b/node_modules/fs-extra/docs/ensureDir.md
new file mode 100644
index 0000000..d030d86
--- /dev/null
+++ b/node_modules/fs-extra/docs/ensureDir.md
@@ -0,0 +1,29 @@
+# ensureDir(dir, [callback])
+
+Ensures that the directory exists. If the directory structure does not exist, it is created. Like `mkdir -p`.
+
+**Aliases:** `mkdirs()`, `mkdirp()`
+
+- `dir` `<String>`
+- `callback` `<Function>`
+
+## Example:
+
+```js
+const fs = require('fs-extra')
+
+const dir = '/tmp/this/path/does/not/exist'
+fs.ensureDir(dir, err => {
+ console.log(err) // => null
+ // dir has now been created, including the directory it is to be placed in
+})
+
+// With Promises:
+fs.ensureDir(dir)
+.then(() => {
+ console.log('success!')
+})
+.catch(err => {
+ console.error(err)
+})
+```