diff options
author | Florian Dold <florian.dold@gmail.com> | 2019-03-27 21:01:33 +0100 |
---|---|---|
committer | Florian Dold <florian.dold@gmail.com> | 2019-03-27 21:01:33 +0100 |
commit | cc97a4dd2a967e1c2273bd5f4c5f49a5bf2e2585 (patch) | |
tree | 92c5d88706a6ffc654d1b133618d357890e7096b /node_modules/fs-extra/docs/fs-read-write.md | |
parent | 3771b4d6b67b34c130f3a9a1a15f42deefdb2eda (diff) |
remove node_modules
Diffstat (limited to 'node_modules/fs-extra/docs/fs-read-write.md')
-rw-r--r-- | node_modules/fs-extra/docs/fs-read-write.md | 39 |
1 files changed, 0 insertions, 39 deletions
diff --git a/node_modules/fs-extra/docs/fs-read-write.md b/node_modules/fs-extra/docs/fs-read-write.md deleted file mode 100644 index 805ea3c38..000000000 --- a/node_modules/fs-extra/docs/fs-read-write.md +++ /dev/null @@ -1,39 +0,0 @@ -# About `fs.read()` & `fs.write()` - -[`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 available in Node 8+) does. - -Here's the example promise usage: - -## `fs.read()` - -```js -// Basic promises -fs.read(fd, buffer, offset, length, position) - .then(results => { - console.log(results) - // { bytesRead: 20, buffer: <Buffer 0f 34 5d ...> } - }) - -// Async/await usage: -async function example () { - const { bytesRead, buffer } = await fs.read(fd, Buffer.alloc(length), offset, length, position) -} -``` - -## `fs.write()` - -```js -// Basic promises -fs.write(fd, buffer, offset, length, position) - .then(results => { - console.log(results) - // { bytesWritten: 20, buffer: <Buffer 0f 34 5d ...> } - }) - -// Async/await usage: -async function example () { - const { bytesWritten, buffer } = await fs.write(fd, Buffer.alloc(length), offset, length, position) -} -``` |