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

doc: fix documentation for fs.createWriteStream highWaterMark option #49456

Merged
merged 6 commits into from
Sep 6, 2023
Merged

doc: fix documentation for fs.createWriteStream highWaterMark option #49456

merged 6 commits into from
Sep 6, 2023

Conversation

mertcanaltin
Copy link
Member

Updated the documentation for the fs.createWriteStream function to clarify the usage of the highWaterMark option. The highWaterMark option was missing from the API docs but is a valid option that can be used with the function. This commit adds a description of the highWaterMark option to the API documentation to improve clarity for developers, especially those using TypeScript.

issue:#49420

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system. labels Sep 2, 2023
@LiviaMedeiros
Copy link
Contributor

Should docs for filehandle.createWriteStream([options]) be updated as well?

@atlowChemi atlowChemi linked an issue Sep 2, 2023 that may be closed by this pull request
Clarify information about using highWaterMark option in fs.createWriteStream #49420
Closed
@mertcanaltin
Copy link
Member Author

Should docs for filehandle.createWriteStream([options]) be updated as well?

Can I add them right away? @LiviaMedeiros

@LiviaMedeiros
Copy link
Contributor

Yes, sure.

@mertcanaltin
Copy link
Member Author

Should docs for filehandle.createWriteStream([options]) be updated as well?

I made an addition

@LiviaMedeiros
Copy link
Contributor

Why fsPromises.opendir?
I guess we should fix the scrolling bug in documentation pages 😅

@mertcanaltin
Copy link
Member Author

Why fsPromises.opendir? I guess we should fix the scrolling bug in documentation pages 😅

When I clicked on the link you posted, I went to him

@mertcanaltin
Copy link
Member Author

Now I think I got it right

@LiviaMedeiros LiviaMedeiros added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Sep 3, 2023
@mertcanaltin
Copy link
Member Author

thankss 🚀

@LiviaMedeiros LiviaMedeiros added commit-queue Add this label to land a pull request using GitHub Actions. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. labels Sep 6, 2023
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Sep 6, 2023
@nodejs-github-bot nodejs-github-bot merged commit d8eb8d0 into nodejs:main Sep 6, 2023
@nodejs-github-bot
Copy link
Collaborator

Landed in d8eb8d0

@Rollphes Rollphes mentioned this pull request Sep 13, 2023
Closed
@Semigradsky Semigradsky mentioned this pull request Sep 13, 2023
Merged
ruyadorno pushed a commit that referenced this pull request Sep 28, 2023
@mertcanaltin @ruyadorno
doc: fix documentation for fs.createWriteStream highWaterMark option
e426b77 
PR-URL: #49456
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: LiviaMedeiros <livia@cirno.name>
@ruyadorno ruyadorno mentioned this pull request Sep 28, 2023
Closed
@ruyadorno ruyadorno mentioned this pull request Sep 28, 2023
Merged
alexfernandez pushed a commit to alexfernandez/node that referenced this pull request Nov 1, 2023
@mertcanaltin @alexfernandez
doc: fix documentation for fs.createWriteStream highWaterMark option
80c867d 
PR-URL: nodejs#49456
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: LiviaMedeiros <livia@cirno.name>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@LiviaMedeiros LiviaMedeiros LiviaMedeiros approved these changes

@UlisesGascon UlisesGascon UlisesGascon approved these changes

@lpinca lpinca lpinca approved these changes

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Clarify information about using highWaterMark option in fs.createWriteStream
5 participants
@mertcanaltin @LiviaMedeiros @nodejs-github-bot @lpinca @UlisesGascon