diff options
Diffstat (limited to 'node_modules/fs-extra/docs')
-rw-r--r-- | node_modules/fs-extra/docs/copy.md | 2 | ||||
-rw-r--r-- | node_modules/fs-extra/docs/fs-read-write.md | 2 | ||||
-rw-r--r-- | node_modules/fs-extra/docs/outputJson-sync.md | 1 | ||||
-rw-r--r-- | node_modules/fs-extra/docs/outputJson.md | 1 | ||||
-rw-r--r-- | node_modules/fs-extra/docs/writeJson-sync.md | 1 | ||||
-rw-r--r-- | node_modules/fs-extra/docs/writeJson.md | 1 |
6 files changed, 6 insertions, 2 deletions
diff --git a/node_modules/fs-extra/docs/copy.md b/node_modules/fs-extra/docs/copy.md index ff0811f50..84407261e 100644 --- a/node_modules/fs-extra/docs/copy.md +++ b/node_modules/fs-extra/docs/copy.md @@ -3,7 +3,7 @@ Copy a file or directory. The directory can have contents. Like `cp -r`. - `src` `<String>` -- `dest` `<String>` +- `dest` `<String>` Note that if `src` is a file, `dest` cannot be a directory (see [issue #323](https://github.com/jprichardson/node-fs-extra/issues/323)). - `options` `<Object>` - `overwrite` `<boolean>`: overwrite existing file or directory, default is `true`. _Note that the copy operation will silently fail if you set this to `false` and the destination exists._ Use the `errorOnExist` option to change this behavior. - `errorOnExist` `<boolean>`: when `overwrite` is `false` and the destination exists, throw an error. Default is `false`. diff --git a/node_modules/fs-extra/docs/fs-read-write.md b/node_modules/fs-extra/docs/fs-read-write.md index 5e5f42070..805ea3c38 100644 --- a/node_modules/fs-extra/docs/fs-read-write.md +++ b/node_modules/fs-extra/docs/fs-read-write.md @@ -2,7 +2,7 @@ [`fs.read()`](https://nodejs.org/api/fs.html#fs_fs_read_fd_buffer_offset_length_position_callback) & [`fs.write()`](https://nodejs.org/api/fs.html#fs_fs_write_fd_buffer_offset_length_position_callback) are different from other `fs` methods in that their callbacks are called with 3 arguments instead of the usual 2 arguments. -If you're using them with callbacks, they will behave as usual. However, their promise usage is a little different. `fs-extra` promisifies these methods like [`util.promisify()`](https://nodejs.org/api/util.html#util_util_promisify_original) (only availible in Node 8+) does. +If you're using them with callbacks, they will behave as usual. However, their promise usage is a little different. `fs-extra` promisifies these methods like [`util.promisify()`](https://nodejs.org/api/util.html#util_util_promisify_original) (only available in Node 8+) does. Here's the example promise usage: diff --git a/node_modules/fs-extra/docs/outputJson-sync.md b/node_modules/fs-extra/docs/outputJson-sync.md index 13c214d1b..ef78f802d 100644 --- a/node_modules/fs-extra/docs/outputJson-sync.md +++ b/node_modules/fs-extra/docs/outputJson-sync.md @@ -8,6 +8,7 @@ Almost the same as [`writeJsonSync`](writeJson-sync.md), except that if the dire - `object` `<Object>` - `options` `<Object>` - `spaces` `<Number|String>` Number of spaces to indent; or a string to use for indentation (i.e. pass `'\t'` for tab indentation). See [the docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_space_argument) for more info. + - `EOL` `<String>` Set EOL character. Default is `\n`. - `replacer` [JSON replacer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_replacer_parameter) - Also accepts [`fs.writeFileSync` options](https://nodejs.org/api/fs.html#fs_fs_writefilesync_file_data_options) diff --git a/node_modules/fs-extra/docs/outputJson.md b/node_modules/fs-extra/docs/outputJson.md index d3fbe670f..7156991e2 100644 --- a/node_modules/fs-extra/docs/outputJson.md +++ b/node_modules/fs-extra/docs/outputJson.md @@ -8,6 +8,7 @@ Almost the same as [`writeJson`](writeJson.md), except that if the directory doe - `object` `<Object>` - `options` `<Object>` - `spaces` `<Number|String>` Number of spaces to indent; or a string to use for indentation (i.e. pass `'\t'` for tab indentation). See [the docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_space_argument) for more info. + - `EOL` `<String>` Set EOL character. Default is `\n`. - `replacer` [JSON replacer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_replacer_parameter) - Also accepts [`fs.writeFile` options](https://nodejs.org/api/fs.html#fs_fs_writefile_file_data_options_callback) - `callback` `<Function>` diff --git a/node_modules/fs-extra/docs/writeJson-sync.md b/node_modules/fs-extra/docs/writeJson-sync.md index d2a3ef642..c22459db8 100644 --- a/node_modules/fs-extra/docs/writeJson-sync.md +++ b/node_modules/fs-extra/docs/writeJson-sync.md @@ -8,6 +8,7 @@ Writes an object to a JSON file. - `object` `<Object>` - `options` `<Object>` - `spaces` `<Number|String>` Number of spaces to indent; or a string to use for indentation (i.e. pass `'\t'` for tab indentation). See [the docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_space_argument) for more info. + - `EOL` `<String>` Set EOL character. Default is `\n`. - `replacer` [JSON replacer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_replacer_parameter) - Also accepts [`fs.writeFileSync` options](https://nodejs.org/api/fs.html#fs_fs_writefilesync_file_data_options) diff --git a/node_modules/fs-extra/docs/writeJson.md b/node_modules/fs-extra/docs/writeJson.md index af94ffc52..8e35271fb 100644 --- a/node_modules/fs-extra/docs/writeJson.md +++ b/node_modules/fs-extra/docs/writeJson.md @@ -8,6 +8,7 @@ Writes an object to a JSON file. - `object` `<Object>` - `options` `<Object>` - `spaces` `<Number|String>` Number of spaces to indent; or a string to use for indentation (i.e. pass `'\t'` for tab indentation). See [the docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_space_argument) for more info. + - `EOL` `<String>` Set EOL character. Default is `\n`. - `replacer` [JSON replacer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_replacer_parameter) - Also accepts [`fs.writeFile` options](https://nodejs.org/api/fs.html#fs_fs_writefile_file_data_options_callback) - `callback` `<Function>` |