From 6e0f0cc361114fab97ea7b1236fe5704d9bd8919 Mon Sep 17 00:00:00 2001 From: Kyo Nagashima Date: Sun, 5 Mar 2017 20:25:36 +0900 Subject: [PATCH] Document `outputFile()` only supports a file path `fs.writeFile()` supports a buffer or a file descriptor as 1st argument (`file`), but `fs-extra.outputFile()` does not. Because it sends `file` parameter to `path.dirname()` that requires `String`. --- docs/outputFile.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/outputFile.md b/docs/outputFile.md index 51fa00fa..df320df2 100644 --- a/docs/outputFile.md +++ b/docs/outputFile.md @@ -1,6 +1,6 @@ # 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. `options` are what you'd pass to [`fs.writeFile()`](https://nodejs.org/api/fs.html#fs_fs_writefile_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). **Sync:** `outputFileSync()`