doc: add more info for timer.setInterval #45232
Merged
Conversation
This file contains 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
nodejs-github-bot
added
doc
Trott
reviewed
Oct 29, 2022
theanarkh
force-pushed
the
add_more_info_for_timer_setInterval
branch
from
5bb43d9
to
de369ac
Compare
Trott
reviewed
Oct 29, 2022
|
@nodejs/timers |
theanarkh
force-pushed
the
add_more_info_for_timer_setInterval
branch
from
de369ac
to
62db6ff
Compare
benjamingr
approved these changes
Nov 2, 2022
Trott
reviewed
Nov 2, 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. | |||
There was a problem hiding this comment.
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 . |
There was a problem hiding this comment.
The document uses active and Libuv uses alive 🤔.
|
@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
added
the
commit-queue
nodejs-github-bot
removed
the
commit-queue
|
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>
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
add more info for
timer.setInterval.Refs: #45224
make -j4 test(UNIX), orvcbuild test(Windows) passes