Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarify information about using highWaterMark option in fs.createWriteStream #49420

Closed
wszydlak opened this issue Aug 31, 2023 · 2 comments · Fixed by #49456
Closed

Clarify information about using highWaterMark option in fs.createWriteStream #49420

wszydlak opened this issue Aug 31, 2023 · 2 comments · Fixed by #49456
Labels
doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system. good first issue Issues that are suitable for first-time contributors.

Comments

@wszydlak
Copy link

Affected URL(s)

No response

Description of the problem

API docs for fs.createWriteStream don't mention option highWaterMark.
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/node package 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.createWriteStream can take highWaterMark and if so - it should be documented in API docs.
@wszydlak wszydlak added the doc Issues and PRs related to the documentations. label Aug 31, 2023
@atlowChemi atlowChemi added good first issue Issues that are suitable for first-time contributors. fs Issues and PRs related to the fs subsystem / file system. labels Sep 1, 2023
@ariel-weiss
Copy link
Contributor

I'd happy to take this issue

@mertcanaltin mertcanaltin mentioned this issue Sep 2, 2023
Merged
@atlowChemi atlowChemi linked a pull request Sep 2, 2023 that will close this issue
doc: fix documentation for fs.createWriteStream highWaterMark option #49456
Merged
@sharma62
Copy link

sharma62 commented Sep 5, 2023

I am glad to resolve the issue.

@Rollphes Rollphes mentioned this issue Sep 13, 2023
Closed
@Semigradsky Semigradsky mentioned this issue Sep 13, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system. good first issue Issues that are suitable for first-time contributors.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

doc: fix documentation for fs.createWriteStream highWaterMark option mertcanaltin/node
4 participants
@wszydlak @ariel-weiss @atlowChemi @sharma62