doc: explicitly document highWaterMark option - #17049
Closed
eps1lon wants to merge 1 commit into
Closed
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
lpinca
approved these changes
Nov 15, 2017
addaleax
approved these changes
Nov 18, 2017
addaleax
pushed a commit
that referenced
this pull request
Nov 18, 2017
PR-URL: #17049 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
MylesBorins
pushed a commit
that referenced
this pull request
Dec 12, 2017
PR-URL: #17049 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
Merged
MylesBorins
pushed a commit
that referenced
this pull request
Dec 19, 2017
PR-URL: #17049 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
gibfahn
pushed a commit
that referenced
this pull request
Dec 19, 2017
PR-URL: #17049 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
Closed
gibfahn
pushed a commit
that referenced
this pull request
Dec 20, 2017
PR-URL: #17049 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
Merged
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
highWaterMark is currently only implicityl documented in a separate paragraph. This PR add this property and its default value to the argument documentation.
The value is set in lib/fs.js#L1990.
Should we add an additional note about what highWaterMark does or is the link to ReadStream enough?
Checklist
Affected core subsystem(s)
doc