Skip to content
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.

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

doc: add timer classes #6206

Closed
wants to merge 1 commit into from
Closed

doc: add timer classes #6206

wants to merge 1 commit into from

Conversation

bengl
Copy link
Member

@bengl bengl commented Apr 14, 2016

Checklist
  • documentation is changed or added
  • the commit message follows commit guidelines
Affected core subsystem(s)

doc

Description of change

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 #5792 w/ @Fishrock123

@Fishrock123 Fishrock123 added doc Issues and PRs related to the documentations. timers Issues and PRs related to the timers subsystem / setImmediate, setInterval, setTimeout. labels Apr 14, 2016
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
Copy link
Contributor

Choose a reason for hiding this comment

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

should be "separate timer" still, the Timeout class is the same.

Copy link
Contributor

Choose a reason for hiding this comment

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

Or, "separate underlying timer handle"

@Fishrock123
Copy link
Contributor

Fishrock123 commented Apr 14, 2016

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.

@bengl
Copy link
Member Author

bengl commented Apr 14, 2016

@Fishrock123 alright, inline comments addressed.

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.

Anything else I should do to address this? Maybe point out the distinction in the class definitions in the doc?

@Fishrock123
Copy link
Contributor

@Fishrock123 Fishrock123 mentioned this pull request Apr 28, 2016
3 tasks
@Fishrock123 Fishrock123 added the wip Issues and PRs that are still a work in progress. label Apr 28, 2016
@bengl
Copy link
Member Author

bengl commented May 6, 2016

@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
@Fishrock123 Fishrock123 removed the wip Issues and PRs that are still a work in progress. label May 6, 2016
@bengl
Copy link
Member Author

bengl commented Jun 6, 2016

Closing as this is now part of #6937

@bengl bengl closed this Jun 6, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. timers Issues and PRs related to the timers subsystem / setImmediate, setInterval, setTimeout.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants