aboutsummaryrefslogtreecommitdiff
path: root/node_modules/fs-extra/docs/outputFile.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/fs-extra/docs/outputFile.md')
-rw-r--r--node_modules/fs-extra/docs/outputFile.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/node_modules/fs-extra/docs/outputFile.md b/node_modules/fs-extra/docs/outputFile.md
new file mode 100644
index 0000000..766787d
--- /dev/null
+++ b/node_modules/fs-extra/docs/outputFile.md
@@ -0,0 +1,34 @@
+# outputFile(file, data, [options, callback])
+
+Almost the same as `writeFile` (i.e. it [overwrites](http://pages.citebite.com/v2o5n8l2f5reb)), except that if the parent directory does not exist, it's created. `file` must be a file path (a buffer or a file descriptor is not allowed). `options` are what you'd pass to [`fs.writeFile()`](https://nodejs.org/api/fs.html#fs_fs_writefile_file_data_options_callback).
+
+- `file` `<String>`
+- `data` `<String> | <Buffer> | <Uint8Array>`
+- `options` `<Object> | <String>`
+- `callback` `<Function>`
+
+## Example:
+
+```js
+const fs = require('fs-extra')
+
+const file = '/tmp/this/path/does/not/exist/file.txt'
+fs.outputFile(file, 'hello!', err => {
+ console.log(err) // => null
+
+ fs.readFile(file, 'utf8', (err, data) => {
+ if (err) return console.error(err)
+ console.log(data) // => hello!
+ })
+})
+
+// With Promises:
+fs.outputFile(file, 'hello!')
+.then(() => fs.readFile(file, 'utf8'))
+.then(data => {
+ console.log(data) // => hello!
+})
+.catch(err => {
+ console.error(err)
+})
+```