doc: add timer classes #6206
doc: add timer classes #6206
Conversation
Fishrock123
added
doc
| running. If the `Timeout` is already `unref`d calling `unref` again will have no | ||
| effect. | ||
|
|
||
| In the case of [`setTimeout`][], `unref` creates a separate `Timeout` that will |
There was a problem hiding this comment.
should be "separate timer" still, the Timeout class is the same.
There was a problem hiding this comment.
Or, "separate underlying timer handle"
|
The concept of timers being different from immediates goes a little beyond the classes in certain implementation and execution details, which is what some of the comments address. |
|
@Fishrock123 alright, inline comments addressed.
Anything else I should do to address this? Maybe point out the distinction in the class definitions in the doc? |
estliberitas
force-pushed
the
master
branch
2 times, most recently
from
7da4fd4
to
c7066fb
Compare
|
don't land this, see https://github.com/nodejs/node/pull/6436/files#r61430203 |
|
@Fishrock123 It looks like #6436 has been updated and no longer collides with this one. I'll rebase though. |
The timers returned by `setTimeout` and friends are actually instances of `Timeout` and `Immediate`. Documenting them as such, so that the `ref` and `unref` methods can be identified as methods on `Timeout` objects. Sparked by discussion in nodejs#5792
|
Closing as this is now part of #6937 |
Checklist
Affected core subsystem(s)
doc
Description of change
The timers returned by
setTimeoutand friends are actually instancesof
TimeoutandImmediate. Documenting them as such, so that therefandunrefmethods can be identified as methods onTimeoutobjects.
Sparked by discussion in #5792 w/ @Fishrock123