FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: fix documentation for fs.createWriteStream highWaterMark option by mertcanaltin · Pull Request #49456 · nodejs/node · GitHub

/ node Public

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

Merged
nodejs-github-bot merged 6 commits into
nodejs:mainfrom
mertcanaltin:dev-49420
Sep 6, 2023
ConversationCommits (6)ChecksFiles changed
Merged

doc: fix documentation for fs.createWriteStream highWaterMark option#49456
nodejs-github-bot merged 6 commits into
nodejs:mainfrom
mertcanaltin:dev-49420

Conversation

mertcanaltin commented Sep 2, 2023

Copy link
Copy Markdown
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 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 commented Sep 2, 2023

Copy link
Copy Markdown
Member

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

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 commented Sep 3, 2023

Copy link
Copy Markdown
Member Author

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

Can I add them right away? @LiviaMedeiros

LiviaMedeiros commented Sep 3, 2023

Copy link
Copy Markdown
Member

Yes, sure.

mertcanaltin commented Sep 3, 2023

Copy link
Copy Markdown
Member Author

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

I made an addition

LiviaMedeiros commented Sep 3, 2023

Copy link
Copy Markdown
Member

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

mertcanaltin commented Sep 3, 2023

Copy link
Copy Markdown
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 commented Sep 3, 2023

Copy link
Copy Markdown
Member Author

Now I think I got it right

LiviaMedeiros added the author ready PRs that have at least one approval, no outstanding review comments, and a CI started. label Sep 3, 2023

mertcanaltin commented Sep 3, 2023

Copy link
Copy Markdown
Member Author

thankss 🚀

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 removed the commit-queue Add this label to land a pull request using GitHub Actions. label Sep 6, 2023
nodejs-github-bot merged commit d8eb8d0 into nodejs:main Sep 6, 2023

nodejs-github-bot commented Sep 6, 2023

Copy link
Copy Markdown
Collaborator

Landed in d8eb8d0

Rollphes mentioned this pull request Sep 13, 2023
Closed
Semigradsky mentioned this pull request Sep 13, 2023
Merged
ruyadorno pushed a commit that referenced this pull request Sep 28, 2023
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 mentioned this pull request Sep 28, 2023
Closed
ruyadorno mentioned this pull request Sep 28, 2023
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

lpinca lpinca approved these changes
UlisesGascon UlisesGascon approved these changes
LiviaMedeiros LiviaMedeiros approved these changes

Assignees

No one assigned

Labels

author ready PRs that have at least one approval, no outstanding review comments, 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

Back | FazBrowse Home | New Git URL