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: document missing options of events.on #52080

Closed
wants to merge 2 commits into from
Closed

doc: document missing options of events.on #52080

wants to merge 2 commits into from

Conversation

atlowChemi
Copy link
Member

@atlowChemi atlowChemi commented Mar 14, 2024 •
edited

Fixes: #52078

Refs: #41276

@nodejs-github-bot nodejs-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
MoLow
MoLow reviewed Mar 14, 2024
View reviewed changes
doc/api/events.md Outdated Show resolved Hide resolved
MoLow
MoLow reviewed Mar 14, 2024
View reviewed changes
doc/api/events.md Outdated Show resolved Hide resolved
atlowChemi
atlowChemi commented Mar 14, 2024
View reviewed changes
doc/api/events.md Outdated Show resolved Hide resolved
doc/api/events.md Outdated Show resolved Hide resolved
@atlowChemi atlowChemi 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
@ehmicky ehmicky mentioned this pull request Mar 14, 2024
Merged
ehmicky
ehmicky reviewed Mar 14, 2024
View reviewed changes
doc/api/events.md Outdated Show resolved Hide resolved
ehmicky
ehmicky reviewed Mar 14, 2024
View reviewed changes
doc/api/events.md Outdated Show resolved Hide resolved
ehmicky
ehmicky reviewed Mar 14, 2024
View reviewed changes
doc/api/events.md Outdated Show resolved Hide resolved
@ehmicky
Copy link

ehmicky commented Mar 14, 2024

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

@atlowChemi atlowChemi 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
Copy link

ehmicky commented Mar 14, 2024

This looks good, thanks @atlowChemi!

@ehmicky ehmicky mentioned this pull request Mar 15, 2024
Merged
@atlowChemi atlowChemi added the request-ci Add this label to start a Jenkins CI on a PR. label Apr 1, 2024
@github-actions github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Apr 1, 2024
@nodejs-github-bot
Copy link
Collaborator

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

@atlowChemi atlowChemi 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-actions github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Apr 1, 2024
@nodejs-github-bot
Copy link
Collaborator

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

@nodejs-github-bot
Copy link
Collaborator

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

@nodejs-github-bot
Copy link
Collaborator

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

@nodejs-github-bot
Copy link
Collaborator

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

@nodejs-github-bot
Copy link
Collaborator

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

@atlowChemi atlowChemi added the request-ci Add this label to start a Jenkins CI on a PR. label Apr 4, 2024
@github-actions github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Apr 4, 2024
@nodejs-github-bot
Copy link
Collaborator

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

@atlowChemi atlowChemi 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-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Apr 5, 2024
@nodejs-github-bot
Copy link
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-bot nodejs-github-bot added the commit-queue-failed An error occurred while landing this pull request using GitHub Actions. label Apr 5, 2024
@atlowChemi atlowChemi 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-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Apr 5, 2024
@nodejs-github-bot
Copy link
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: #52080
Fixes: #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>
@RafaelGSS RafaelGSS 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: #52080
Fixes: #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-ippolito marco-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: #52080
Fixes: #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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ehmicky ehmicky ehmicky left review comments

@MoLow MoLow MoLow approved these changes

@aymen94 aymen94 aymen94 approved these changes

@trivikr trivikr trivikr approved these changes

@benjamingr benjamingr Awaiting requested review from benjamingr

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-rebase Add this label to allow the Commit Queue to land a PR in several commits. doc Issues and PRs related to the documentations. events Issues and PRs related to the events subsystem / EventEmitter. needs-ci PRs 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