aboutsummaryrefslogtreecommitdiff
path: root/node_modules/fs-extra/docs/ensureFile.md
diff options
context:
space:
mode:
authorDimitri Staessens <[email protected]>2019-10-06 21:37:45 +0200
committerDimitri Staessens <[email protected]>2019-10-06 21:37:45 +0200
commit3c51c3be85bb0d1bdb87ea0d6632f1c256912f27 (patch)
treec7ccc8279b12c4f7bdbbb4270d617e48f51722e4 /node_modules/fs-extra/docs/ensureFile.md
parent412c104bebc507bea9c94fd53b5bdc4b64cbfe31 (diff)
downloadwebsite-3c51c3be85bb0d1bdb87ea0d6632f1c256912f27.tar.gz
website-3c51c3be85bb0d1bdb87ea0d6632f1c256912f27.zip
build: Add some required modules for node
Diffstat (limited to 'node_modules/fs-extra/docs/ensureFile.md')
-rw-r--r--node_modules/fs-extra/docs/ensureFile.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/node_modules/fs-extra/docs/ensureFile.md b/node_modules/fs-extra/docs/ensureFile.md
new file mode 100644
index 0000000..987be63
--- /dev/null
+++ b/node_modules/fs-extra/docs/ensureFile.md
@@ -0,0 +1,29 @@
+# ensureFile(file, [callback])
+
+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:** `createFile()`
+
+- `file` `<String>`
+- `callback` `<Function>`
+
+## Example:
+
+```js
+const fs = require('fs-extra')
+
+const file = '/tmp/this/path/does/not/exist/file.txt'
+fs.ensureFile(file, err => {
+ console.log(err) // => null
+ // file has now been created, including the directory it is to be placed in
+})
+
+// With Promises:
+fs.ensureFile(file)
+.then(() => {
+ console.log('success!')
+})
+.catch(err => {
+ console.error(err)
+})
+```