aboutsummaryrefslogtreecommitdiff
path: root/node_modules/fs-extra/docs/outputFile-sync.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/fs-extra/docs/outputFile-sync.md')
-rw-r--r--node_modules/fs-extra/docs/outputFile-sync.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/node_modules/fs-extra/docs/outputFile-sync.md b/node_modules/fs-extra/docs/outputFile-sync.md
new file mode 100644
index 0000000..38eee8b
--- /dev/null
+++ b/node_modules/fs-extra/docs/outputFile-sync.md
@@ -0,0 +1,19 @@
+# outputFileSync(file, data, [options])
+
+Almost the same as `writeFileSync` (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.writeFileSync()`](https://nodejs.org/api/fs.html#fs_fs_writefilesync_file_data_options).
+
+- `file` `<String>`
+- `data` `<String> | <Buffer> | <Uint8Array>`
+- `options` `<Object> | <String>`
+
+## Example:
+
+```js
+const fs = require('fs-extra')
+
+const file = '/tmp/this/path/does/not/exist/file.txt'
+fs.outputFileSync(file, 'hello!')
+
+const data = fs.readFileSync(file, 'utf8')
+console.log(data) // => hello!
+```