-
-
Notifications
You must be signed in to change notification settings - Fork 35.8k
Clarify information about using highWaterMark option in fs.createWriteStream #49420
Copy link
Copy link
Closed
Closed
Copy link
Labels
docIssues and PRs related to the documentations.Issues and PRs related to the documentations.fsIssues and PRs related to the fs subsystem / file system.Issues and PRs related to the fs subsystem / file system.good first issueIssues that are suitable for first-time contributors.Issues that are suitable for first-time contributors.
Description
Metadata
Metadata
Assignees
Labels
docIssues and PRs related to the documentations.Issues and PRs related to the documentations.fsIssues and PRs related to the fs subsystem / file system.Issues and PRs related to the fs subsystem / file system.good first issueIssues that are suitable for first-time contributors.Issues that are suitable for first-time contributors.
Type
Fields
Give feedbackNo fields configured for issues without a type.
Affected URL(s)
No response
Description of the problem
API docs for
fs.createWriteStreamdon't mention optionhighWaterMark.However according to source code and tests (https://github.com/nodejs/node/blob/main/test/parallel/test-file-write-stream2.js#L67) this option is valid and passed to
stream.Writable, so developers can use them.In
@types/nodepackage this option is not available (as types covers API docs) so i cannot use this option when writing code in typescript.Please clarify if
fs.createWriteStreamcan takehighWaterMarkand if so - it should be documented in API docs.