summaryrefslogtreecommitdiff
path: root/node_modules/fs-extra/docs/ensureFile.md
diff options
context:
space:
mode:
authorLinuxWizard42 <computerwizard@linuxmail.org>2022-10-12 22:54:37 +0300
committerLinuxWizard42 <computerwizard@linuxmail.org>2022-10-12 22:54:37 +0300
commit703e03aba33f234712206769f57717ba7d92d23d (patch)
tree0041f04ccb75bd5379c764e9fe42249fffe75fc3 /node_modules/fs-extra/docs/ensureFile.md
parentab6e257e6e9d9a483d7e86f220d8b209a2cd7753 (diff)
downloadFlashRunner-703e03aba33f234712206769f57717ba7d92d23d.tar.gz
FlashRunner-703e03aba33f234712206769f57717ba7d92d23d.tar.zst
Added export_allowed file to make repository visible in cgit
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)
+})
+```