From 2731d08c332e2e269b30f1c6ac3916ac15b0a27f Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Wed, 26 Sep 2018 06:15:54 -0700 Subject: [PATCH] doc: add links for fs.createWriteStream() Supply links for fs.createWriteStream() in fs.md. PR-URL: https://github.com/nodejs/node/pull/23104 Reviewed-By: Denys Otrishko Reviewed-By: Vse Mozhet Byt Reviewed-By: Trivikram Kamat Reviewed-By: Sakthipriyan Vairamani Reviewed-By: Colin Ihrig --- doc/api/fs.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/doc/api/fs.md b/doc/api/fs.md index 680b958929f70a..879ec07917f939 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -829,7 +829,7 @@ added: v0.1.93 --> The path to the file the stream is writing to as specified in the first -argument to `fs.createWriteStream()`. If `path` is passed as a string, then +argument to [`fs.createWriteStream()`][]. If `path` is passed as a string, then `writeStream.path` will be a string. If `path` is passed as a `Buffer`, then `writeStream.path` will be a `Buffer`. @@ -3428,7 +3428,8 @@ If this method is invoked as its [`util.promisify()`][]ed version, it returns a `Promise` for an `Object` with `bytesWritten` and `buffer` properties. It is unsafe to use `fs.write()` multiple times on the same file without waiting -for the callback. For this scenario, `fs.createWriteStream()` is recommended. +for the callback. For this scenario, [`fs.createWriteStream()`][] is +recommended. On Linux, positional writes don't work when the file is opened in append mode. The kernel ignores the position argument and always appends the data to @@ -3475,7 +3476,8 @@ written is not necessarily the same as string characters written. See [`Buffer.byteLength`][]. It is unsafe to use `fs.write()` multiple times on the same file without waiting -for the callback. For this scenario, `fs.createWriteStream()` is recommended. +for the callback. For this scenario, [`fs.createWriteStream()`][] is +recommended. On Linux, positional writes don't work when the file is opened in append mode. The kernel ignores the position argument and always appends the data to @@ -3536,7 +3538,7 @@ fs.writeFile('message.txt', 'Hello Node.js', 'utf8', callback); Any specified file descriptor has to support writing. It is unsafe to use `fs.writeFile()` multiple times on the same file without -waiting for the callback. For this scenario, `fs.createWriteStream()` is +waiting for the callback. For this scenario, [`fs.createWriteStream()`][] is recommended. If a file descriptor is specified as the `file`, it will not be closed @@ -3905,7 +3907,7 @@ at the current position. See pwrite(2). It is unsafe to use `filehandle.write()` multiple times on the same file without waiting for the `Promise` to be resolved (or rejected). For this -scenario, `fs.createWriteStream` is strongly recommended. +scenario, [`fs.createWriteStream()`][] is strongly recommended. On Linux, positional writes do not work when the file is opened in append mode. The kernel ignores the position argument and always appends the data to @@ -4787,6 +4789,7 @@ the file contents. [`fs.chmod()`]: #fs_fs_chmod_path_mode_callback [`fs.chown()`]: #fs_fs_chown_path_uid_gid_callback [`fs.copyFile()`]: #fs_fs_copyfile_src_dest_flags_callback +[`fs.createWriteStream()`]: #fs_fs_createwritestream_path_options [`fs.exists()`]: fs.html#fs_fs_exists_path_callback [`fs.fstat()`]: #fs_fs_fstat_fd_options_callback [`fs.ftruncate()`]: #fs_fs_ftruncate_fd_len_callback