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: add comment about highWaterMark limit #33432

Closed
wants to merge 1 commit into from
Closed

doc: add comment about highWaterMark limit #33432

wants to merge 1 commit into from

Conversation

benjamingr
Copy link
Member

Add a comment regarding memory limits and setting highWaterMark

See #33387 (comment) and #33387 (comment) @nodejs/streams

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines

@benjamingr benjamingr added the doc Issues and PRs related to the documentations. label May 16, 2020
@nodejs-github-bot nodejs-github-bot added the stream Issues and PRs related to the stream subsystem. label May 16, 2020
@benjamingr benjamingr mentioned this pull request May 16, 2020
Closed
4 tasks
vweevers
vweevers reviewed May 16, 2020
View reviewed changes
doc/api/stream.md Outdated Show resolved Hide resolved
@benjamingr benjamingr force-pushed the doc-update-watermark-comment branch from 35ba340 to 588cde4 Compare May 16, 2020 13:39
@benjamingr
doc: add comment about highWaterMark limit
d2e3ea5 
Add a comment regarding memory limits and setting highWaterMark

PR-URL: nodejs#33432
Reviewd-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Robert Nagy <ronagy@icloud.com>
@benjamingr benjamingr force-pushed the doc-update-watermark-comment branch from 588cde4 to d2e3ea5 Compare May 16, 2020 13:42
mcollina
mcollina approved these changes May 16, 2020
View reviewed changes
Copy link
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

bnoordhuis
bnoordhuis approved these changes May 16, 2020
View reviewed changes
Copy link
Member

@bnoordhuis bnoordhuis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A code example that shows when to use a HWM might be good too but I have a hard time coming up with one that's not utterly contrived and still succinct.

addaleax pushed a commit that referenced this pull request May 19, 2020
@benjamingr @addaleax
doc: add comment about highWaterMark limit
b51d1cf 
Add a comment regarding memory limits and setting highWaterMark

PR-URL: #33432
Reviewd-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Robert Nagy <ronagy@icloud.com>

Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@addaleax
Copy link
Member

Landed in b51d1cf

@addaleax addaleax closed this May 19, 2020
codebytere pushed a commit that referenced this pull request May 21, 2020
@benjamingr @codebytere
doc: add comment about highWaterMark limit
7ee4adc 
Add a comment regarding memory limits and setting highWaterMark

PR-URL: #33432
Reviewd-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Robert Nagy <ronagy@icloud.com>

Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
codebytere pushed a commit that referenced this pull request Jun 7, 2020
@benjamingr @codebytere
doc: add comment about highWaterMark limit
2635808 
Add a comment regarding memory limits and setting highWaterMark

PR-URL: #33432
Reviewd-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Robert Nagy <ronagy@icloud.com>

Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
codebytere pushed a commit that referenced this pull request Jun 9, 2020
@benjamingr @codebytere
doc: add comment about highWaterMark limit
4749156 
Add a comment regarding memory limits and setting highWaterMark

PR-URL: #33432
Reviewd-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Robert Nagy <ronagy@icloud.com>

Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@codebytere codebytere mentioned this pull request Jun 9, 2020
Merged
@codebytere codebytere mentioned this pull request Jun 28, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vweevers vweevers vweevers left review comments

@mcollina mcollina mcollina approved these changes

@bnoordhuis bnoordhuis bnoordhuis approved these changes

@lpinca lpinca lpinca approved these changes

@cjihrig cjihrig cjihrig approved these changes

@ronag ronag ronag approved these changes

@BridgeAR BridgeAR BridgeAR approved these changes

@jasnell jasnell Awaiting requested review from jasnell

@addaleax addaleax Awaiting requested review from addaleax

Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. stream Issues and PRs related to the stream subsystem.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
10 participants
@benjamingr @addaleax @mcollina @bnoordhuis @lpinca @cjihrig @vweevers @ronag @BridgeAR @nodejs-github-bot