diff options
author | Michele Caini <michele.caini@gmail.com> | 2015-06-25 16:13:49 +0200 |
---|---|---|
committer | James M Snell <jasnell@gmail.com> | 2015-08-03 20:44:40 -0700 |
commit | 59c67fe3cda1163e4e3cf66a8ab16e7b6d72e6a3 (patch) | |
tree | de76bdad59a8f7f5852fa7cfbc0ff008df842b60 | |
parent | 5ccb429ee8556ac0cbc81dddc2d5a2a4f5d75b58 (diff) | |
download | node-59c67fe3cda1163e4e3cf66a8ab16e7b6d72e6a3.tar.gz |
updated documentation for fs.createReadStream
Reviewed-By: James M Snell <jasnell@gmail.com>
PR-URL: https://github.com/joyent/node/pull/25591
-rw-r--r-- | doc/api/fs.markdown | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/api/fs.markdown b/doc/api/fs.markdown index 9da32d376..3c5f6f9a0 100644 --- a/doc/api/fs.markdown +++ b/doc/api/fs.markdown @@ -775,6 +775,10 @@ on Unix systems, it never was. Returns a new ReadStream object (See `Readable Stream`). +Be aware that, unlike the default value set for `highWaterMark` on a +readable stream (16kB), the stream returned by this method has a +default value of 64kB for the same parameter. + `options` is an object with the following defaults: { flags: 'r', |