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.

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

doc: add more info for timer.setInterval #45232

Merged

Conversation

theanarkh
Copy link
Contributor

add more info for timer.setInterval.
Refs: #45224

  • 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

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. timers Issues and PRs related to the timers subsystem / setImmediate, setInterval, setTimeout. labels Oct 29, 2022
doc/api/timers.md Outdated Show resolved Hide resolved
@theanarkh theanarkh force-pushed the add_more_info_for_timer_setInterval branch from 5bb43d9 to de369ac Compare October 29, 2022 17:32
doc/api/timers.md Outdated Show resolved Hide resolved
@Trott
Copy link
Member

Trott commented Oct 29, 2022

@nodejs/timers

@theanarkh theanarkh force-pushed the add_more_info_for_timer_setInterval branch from de369ac to 62db6ff Compare October 29, 2022 20:55
@theanarkh theanarkh added the review wanted PRs that need reviews. label Oct 31, 2022
@@ -442,6 +442,8 @@ added: v15.9.0
-->

Returns an async iterator that generates values in an interval of `delay` ms.
If `ref` is `true`, you need to call `next()` of async iterator explicitly
or implicitly to keep the event loop alive.
Copy link
Member

Choose a reason for hiding this comment

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

I think we usually use the word "open" instead of "alive" to describe the event loop, but let's ping @nodejs/documentation for confirmation.

Suggested change
or implicitly to keep the event loop alive.
or implicitly to keep the event loop open .

Copy link
Contributor Author

@theanarkh theanarkh Nov 3, 2022

Choose a reason for hiding this comment

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

The document uses active and Libuv uses alive 🤔.

@theanarkh
Copy link
Contributor Author

@Trott Hi, can this PR be merged ?

@Trott
Copy link
Member

Trott commented Nov 6, 2022

@Trott Hi, can this PR be merged ?

Yes. If I want to try to get consistency across all our docs regarding event loop terminology, I'll do that in a separate PR. There's no reason to hold this one up over that, though.

@Trott Trott added the commit-queue Add this label to land a pull request using GitHub Actions. label Nov 6, 2022
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Nov 6, 2022
@nodejs-github-bot nodejs-github-bot merged commit 4fc6ef5 into nodejs:main Nov 6, 2022
@nodejs-github-bot
Copy link
Collaborator

Landed in 4fc6ef5

lucshi pushed a commit to lucshi/node that referenced this pull request Nov 9, 2022
PR-URL: nodejs#45232
Refs: nodejs#45224
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
RafaelGSS pushed a commit that referenced this pull request Nov 10, 2022
PR-URL: #45232
Refs: #45224
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
@RafaelGSS RafaelGSS mentioned this pull request Nov 10, 2022
danielleadams pushed a commit that referenced this pull request Dec 30, 2022
PR-URL: #45232
Refs: #45224
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
danielleadams pushed a commit that referenced this pull request Dec 30, 2022
PR-URL: #45232
Refs: #45224
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
danielleadams pushed a commit that referenced this pull request Jan 3, 2023
PR-URL: #45232
Refs: #45224
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. review wanted PRs that need reviews. timers Issues and PRs related to the timers subsystem / setImmediate, setInterval, setTimeout.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants