doc: explicitly document highWaterMark option #17049
Closed
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.
highWaterMarkis 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
highWaterMarkdoes or is the link toReadStreamenough?Checklist
Affected core subsystem(s)
doc