Skip to content

doc: document missing options of events.on - #52080

Closed
atlowChemi wants to merge 2 commits into
nodejs:mainfrom
atlowChemi:document-events-on-options
Closed

doc: document missing options of events.on#52080
atlowChemi wants to merge 2 commits into
nodejs:mainfrom
atlowChemi:document-events-on-options

Conversation

@atlowChemi

@atlowChemiatlowChemi commented Mar 14, 2024•
edited
Loading

Copy link
Copy Markdown
Member

Fixes: #52078

Refs: #41276

@nodejs-github-botnodejs-github-bot added doc Issues and PRs related to the documentations. events Issues and PRs related to the events subsystem / EventEmitter. labels Mar 14, 2024
@atlowChemi
atlowChemiforce-pushed the document-events-on-options branch from 01703c3 to 3b693acCompareMarch 14, 2024 08:07
MoLow
MoLow reviewed Mar 14, 2024
View reviewed changes
Comment threaddoc/api/events.md Outdated
MoLow
MoLow reviewed Mar 14, 2024
View reviewed changes
Comment threaddoc/api/events.md Outdated
atlowChemi
atlowChemi commented Mar 14, 2024
View reviewed changes
Comment threaddoc/api/events.md Outdated
Comment threaddoc/api/events.md Outdated
@atlowChemiatlowChemi added the commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. label Mar 14, 2024
@ehmickyehmicky mentioned this pull request Mar 14, 2024
Merged
ehmicky
ehmicky reviewed Mar 14, 2024
View reviewed changes
Comment threaddoc/api/events.md Outdated
ehmicky
ehmicky reviewed Mar 14, 2024
View reviewed changes
Comment threaddoc/api/events.md Outdated
ehmicky
ehmicky reviewed Mar 14, 2024
View reviewed changes
Comment threaddoc/api/events.md Outdated
ehmicky
ehmicky reviewed Mar 14, 2024
View reviewed changes
Comment threaddoc/api/events.md Outdated
@ehmicky

ehmicky commented Mar 14, 2024

Copy link
Copy Markdown

Thanks a lot for working on this @atlowChemi, those options are very useful!

@atlowChemi
atlowChemiforce-pushed the document-events-on-options branch from 8f85a99 to 2b844edCompareMarch 14, 2024 23:02
@atlowChemiatlowChemi added needs-ci PRs that need a full CI run. and removed commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. labels Mar 14, 2024
@ehmicky

ehmicky commented Mar 14, 2024

Copy link
Copy Markdown

This looks good, thanks @atlowChemi!

@ehmickyehmicky mentioned this pull request Mar 15, 2024
Merged
@atlowChemi
atlowChemiforce-pushed the document-events-on-options branch from 2b844ed to ac60b76CompareMarch 17, 2024 07:07
@atlowChemiatlowChemi added the request-ci Add this label to start a Jenkins CI on a PR. label Apr 1, 2024
@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Apr 1, 2024
@nodejs-github-bot

nodejs-github-bot commented Apr 1, 2024

Copy link
Copy Markdown
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/58042/

@atlowChemiatlowChemi added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. request-ci Add this label to start a Jenkins CI on a PR. labels Apr 1, 2024
@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Apr 1, 2024
@nodejs-github-bot

nodejs-github-bot commented Apr 1, 2024

Copy link
Copy Markdown
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/58043/

@nodejs-github-bot

nodejs-github-bot commented Apr 2, 2024

Copy link
Copy Markdown
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/58058/

@nodejs-github-bot

nodejs-github-bot commented Apr 4, 2024

Copy link
Copy Markdown
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/58093/

@atlowChemi
atlowChemiforce-pushed the document-events-on-options branch from ac60b76 to 280ab66CompareApril 4, 2024 13:46
@atlowChemiatlowChemi added the request-ci Add this label to start a Jenkins CI on a PR. label Apr 4, 2024
@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Apr 4, 2024
@nodejs-github-bot

nodejs-github-bot commented Apr 4, 2024

Copy link
Copy Markdown
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/58118/

@atlowChemiatlowChemi added commit-queue Add this label to land a pull request using GitHub Actions. commit-queue-rebase Add this label to allow the Commit Queue to land a PR in several commits. labels Apr 5, 2024
@nodejs-github-botnodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Apr 5, 2024
@nodejs-github-bot

nodejs-github-bot commented Apr 5, 2024

Copy link
Copy Markdown
Collaborator
Commit Queue failed
- Loading data for nodejs/node/pull/52080
✔ Done loading data for nodejs/node/pull/52080
----------------------------------- PR info ------------------------------------
Title doc: document missing options of events.on (#52080)
Author Chemi Atlow (@atlowChemi)
Branch atlowChemi:document-events-on-options -> nodejs:main
Labels doc, events, author ready, needs-ci, commit-queue-rebase
Commits 2
- events: rename high & low watermark for consistency
- doc: document missing options of events.on
Committers 1
- atlowChemi PR-URL: https://github.com/nodejs/node/pull/52080
Fixes: https://github.com/nodejs/node/issues/52078
Refs: https://github.com/nodejs/node/pull/41276
Reviewed-By: Moshe Atlow Reviewed-By: Trivikram Kamat ------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/52080
Fixes: https://github.com/nodejs/node/issues/52078
Refs: https://github.com/nodejs/node/pull/41276
Reviewed-By: Moshe Atlow Reviewed-By: Trivikram Kamat --------------------------------------------------------------------------------
⚠ Commits were pushed since the last approving review:
⚠ - events: rename high & low watermark for consistency
⚠ - doc: document missing options of events.on
ℹ This PR was created on Thu, 14 Mar 2024 08:03:36 GMT
✔ Approvals: 2
✔ - Moshe Atlow (@MoLow) (TSC): https://github.com/nodejs/node/pull/52080#pullrequestreview-1972026393
✔ - Trivikram Kamat (@trivikr): https://github.com/nodejs/node/pull/52080#pullrequestreview-1972637799
✔ Last GitHub CI successful
ℹ Last Full PR CI on 2024-04-04T14:50:00Z: https://ci.nodejs.org/job/node-test-pull-request/58118/
- Querying data for job/node-test-pull-request/58118/
✔ Last Jenkins CI successful
--------------------------------------------------------------------------------
✔ Aborted `git node land` session in /home/runner/work/node/node/.ncu
https://github.com/nodejs/node/actions/runs/8570189085

@nodejs-github-botnodejs-github-bot added the commit-queue-failed An error occurred while landing this pull request using GitHub Actions. label Apr 5, 2024
@atlowChemiatlowChemi added commit-queue Add this label to land a pull request using GitHub Actions. and removed commit-queue-failed An error occurred while landing this pull request using GitHub Actions. labels Apr 5, 2024
@nodejs-github-botnodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Apr 5, 2024
@nodejs-github-bot

nodejs-github-bot commented Apr 5, 2024

Copy link
Copy Markdown
Collaborator

Landed in ec15504...d0c364a

nodejs-github-bot pushed a commit that referenced this pull request Apr 5, 2024
@atlowChemi@nodejs-github-bot
events: rename high & low watermark for consistency
d619aab
PR-URL: #52080Fixes: #52078
Refs: #41276
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
nodejs-github-bot pushed a commit that referenced this pull request Apr 5, 2024
@atlowChemi@nodejs-github-bot
doc: document missing options of events.on
d0c364a
Fixes: #52078
Refs: #41276
PR-URL: #52080
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
@RafaelGSSRafaelGSS mentioned this pull request Apr 15, 2024
Merged
marco-ippolito pushed a commit that referenced this pull request May 2, 2024
@atlowChemi@marco-ippolito
events: rename high & low watermark for consistency
b81acd3
PR-URL: #52080Fixes: #52078
Refs: #41276
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
marco-ippolito pushed a commit that referenced this pull request May 2, 2024
@atlowChemi@marco-ippolito
doc: document missing options of events.on
c51f056
Fixes: #52078
Refs: #41276
PR-URL: #52080
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
@marco-ippolitomarco-ippolito mentioned this pull request May 2, 2024
Merged
marco-ippolito pushed a commit that referenced this pull request May 3, 2024
@atlowChemi@marco-ippolito
events: rename high & low watermark for consistency
7bfb0b4
PR-URL: #52080Fixes: #52078
Refs: #41276
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
marco-ippolito pushed a commit that referenced this pull request May 3, 2024
@atlowChemi@marco-ippolito
doc: document missing options of events.on
c55a3be
Fixes: #52078
Refs: #41276
PR-URL: #52080
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
@PutziSanPutziSan mentioned this pull request May 26, 2024
Merged
7 tasks
@atlowChemi
atlowChemi deleted the document-events-on-options branch July 21, 2024 20:09
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@MoLowMoLowMoLow approved these changes
@trivikrtrivikrtrivikr approved these changes
@benjamingrbenjamingrAwaiting requested review from benjamingr
+2 more reviewers
@ehmickyehmickyehmicky left review comments
@aymen94aymen94aymen94 approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

author readyPRs that have at least one approval, no pending requests for changes, and a CI started.commit-queue-rebaseAdd this label to allow the Commit Queue to land a PR in several commits.docIssues and PRs related to the documentations.eventsIssues and PRs related to the events subsystem / EventEmitter.needs-ciPRs that need a full CI run.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Document highWaterMark option of events.on()

7 participants

@atlowChemi@ehmicky@nodejs-github-bot@benjamingr@MoLow@aymen94@trivikr