FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: add more info for timer.setInterval by theanarkh · Pull Request #45232 · nodejs/node · GitHub

/ node Public

doc: add more info for timer.setInterval - #45232

Merged
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
theanarkh:add_more_info_for_timer_setInterval
Nov 6, 2022
ConversationCommits (1)ChecksFiles changed
Merged

doc: add more info for timer.setInterval#45232
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
theanarkh:add_more_info_for_timer_setInterval

Conversation

theanarkh commented Oct 29, 2022

Copy link
Copy Markdown
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 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
Trott reviewed Oct 29, 2022
View reviewed changes
Comment thread doc/api/timers.md Outdated
theanarkh force-pushed the add_more_info_for_timer_setInterval branch from 5bb43d9 to de369ac Compare October 29, 2022 17:32
Trott reviewed Oct 29, 2022
View reviewed changes
Comment thread doc/api/timers.md Outdated

Trott commented Oct 29, 2022

Copy link
Copy Markdown
Member

@nodejs/timers

theanarkh force-pushed the add_more_info_for_timer_setInterval branch from de369ac to 62db6ff Compare October 29, 2022 20:55
theanarkh added the review wanted PRs that need reviews. label Oct 31, 2022
Trott reviewed Nov 2, 2022
View reviewed changes
Comment thread doc/api/timers.md

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.

Trott Nov 2, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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 .

theanarkh Nov 3, 2022 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

The document uses active and Libuv uses alive 🤔.

theanarkh commented Nov 6, 2022

Copy link
Copy Markdown
Contributor Author

@Trott Hi, can this PR be merged ?

Trott commented Nov 6, 2022

Copy link
Copy Markdown
Member

@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 Add this label to land a pull request using GitHub Actions. label Nov 6, 2022
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 merged commit 4fc6ef5 into nodejs:main Nov 6, 2022

nodejs-github-bot commented Nov 6, 2022

Copy link
Copy Markdown
Collaborator

Landed in 4fc6ef5

RafaelGSS pushed a commit that referenced this pull request Nov 10, 2022
doc: add more info for timer.setInterval
3de1257 
PR-URL: #45232
Refs: #45224
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
RafaelGSS mentioned this pull request Nov 10, 2022
Merged
danielleadams mentioned this pull request Dec 30, 2022
Merged
danielleadams pushed a commit that referenced this pull request Dec 30, 2022
doc: add more info for timer.setInterval
f6d084a 
PR-URL: #45232
Refs: #45224
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
danielleadams pushed a commit that referenced this pull request Jan 3, 2023
doc: add more info for timer.setInterval
90a2892 
PR-URL: #45232
Refs: #45224
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
This file contains hidden or 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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Trott Trott left review comments
benjamingr benjamingr approved these changes

Assignees

No one assigned

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

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

Back | FazBrowse Home | New Git URL