timers: add hasRef method to Timeout & Immediate #20898
Closed
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
Provide a way to check whether the current timer or immediate is refed.
apapirovski
added
timers
nodejs-github-bot
added
the
timers
apapirovski
force-pushed
the
patch-timers-has-ref
branch
from
dac0830
to
ebb23e4
Compare
addaleax
approved these changes
May 22, 2018
addaleax
added
semver-minor
jasnell
reviewed
May 23, 2018
| @@ -23,6 +23,16 @@ running as long as the immediate is active. The `Immediate` object returned by | |||
| [`setImmediate()`][] exports both `immediate.ref()` and `immediate.unref()` | |||
| functions that can be used to control this default behavior. | |||
|
|
|||
| ### immediate.hasRef() | |||
There was a problem hiding this comment.
hmm... maybe isRef()? hasRef just seems... awkward.
There was a problem hiding this comment.
hasRef matches the HandleWrap, hence that choice. Open to other names if there's a consensus.
There was a problem hiding this comment.
I don't really mind what is chosen
jasnell
approved these changes
May 23, 2018
TimothyGu
approved these changes
May 23, 2018
| @@ -23,6 +23,16 @@ running as long as the immediate is active. The `Immediate` object returned by | |||
| [`setImmediate()`][] exports both `immediate.ref()` and `immediate.unref()` | |||
| functions that can be used to control this default behavior. | |||
|
|
|||
| ### immediate.hasRef() | |||
cjihrig
approved these changes
May 23, 2018
doc/api/timers.md
Outdated
|
|
||
| * Returns: {boolean} | ||
|
|
||
| Used to check whether the `Immediate` object will keep the Node.js event loop |
There was a problem hiding this comment.
Maybe replace "Used to check whether ..." with "If true, ..."
doc/api/timers.md
Outdated
|
|
||
| * Returns: {boolean} | ||
|
|
||
| Used to check whether the `Timeout` object will keep the Node.js event loop |
| const assert = require('assert'); | ||
|
|
||
| const immediate = setImmediate(() => {}); | ||
| assert(immediate.hasRef()); |
There was a problem hiding this comment.
Can you use assert.strictEqual() in these tests.
BridgeAR
approved these changes
May 24, 2018
BridgeAR
added
the
author ready
Fishrock123
approved these changes
Jun 1, 2018
|
Landed in 48a2568 |
apapirovski
added a commit
that referenced
this pull request
Jun 1, 2018
Provide a way to check whether the current timer or immediate is refed. PR-URL: #20898 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
targos
removed
the
author ready
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.
Provide a way to check whether the current timer or immediate is refed. This was done as per request from @Fishrock123 due to the removal of _handle from unrefed timers.
The method name was chosen to match what used to be available on the
_handle— unlike a getter it should also make it clear that it's not possible to change it by trying to assign.(Since it depends on a
semver-majorPR, I'm labeling this as such too.)Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes