Skip to content

doc: add more info for timer.setInterval #45232

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

Merged
nodejs-github-bot merged 1 commit into from
Nov 6, 2022
Merged

doc: add more info for timer.setInterval #45232

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions doc/api/timers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

@Trott Trott Nov 2, 2022

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 •
edited
Loading

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 🤔.


* `delay` {number} The number of milliseconds to wait between iterations.
**Default:** `1`.
Expand Down