aboutsummaryrefslogtreecommitdiff
path: root/node_modules/fs-extra/docs/ensureFile-sync.md
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2017-05-24 15:10:37 +0200
committerFlorian Dold <florian.dold@gmail.com>2017-05-24 15:11:17 +0200
commit7a3df06eb573d36142bd1a8e03c5ce8752d300b3 (patch)
tree70bfaea8884c374876f607774850a3a51c0cb381 /node_modules/fs-extra/docs/ensureFile-sync.md
parentaca1143cb9eed16cf37f04e475e4257418dd18ac (diff)
fix build issues and add typedoc
Diffstat (limited to 'node_modules/fs-extra/docs/ensureFile-sync.md')
-rw-r--r--node_modules/fs-extra/docs/ensureFile-sync.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/node_modules/fs-extra/docs/ensureFile-sync.md b/node_modules/fs-extra/docs/ensureFile-sync.md
new file mode 100644
index 000000000..25ac39dec
--- /dev/null
+++ b/node_modules/fs-extra/docs/ensureFile-sync.md
@@ -0,0 +1,17 @@
+# ensureFileSync(file)
+
+Ensures that the file exists. If the file that is requested to be created is in directories that do not exist, these directories are created. If the file already exists, it is **NOT MODIFIED**.
+
+**Alias:** `createFileSync()`
+
+- `file` `<String>`
+
+## Example:
+
+```js
+const fs = require('fs-extra')
+
+const file = '/tmp/this/path/does/not/exist/file.txt'
+fs.ensureFileSync(file)
+// file has now been created, including the directory it is to be placed in
+```