Skip to content

doc: add timer classes - #6206

Closed
bengl wants to merge 1 commit into
nodejs:masterfrom
bengl:timerclasses
Closed

doc: add timer classes#6206
bengl wants to merge 1 commit into
nodejs:masterfrom
bengl:timerclasses

Conversation

@bengl

@benglbengl commented Apr 14, 2016

Copy link
Copy Markdown
Member
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

@Fishrock123Fishrock123 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
Fishrock123
Fishrock123 reviewed Apr 14, 2016
View reviewed changes
Comment threaddoc/api/timers.markdown Outdated

@Fishrock123Fishrock123Apr 14, 2016

Copy link
Copy Markdown
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.

@Fishrock123Fishrock123Apr 14, 2016

Copy link
Copy Markdown
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

Fishrock123 commented Apr 14, 2016•
edited
Loading

Copy link
Copy Markdown
Contributor

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

bengl commented Apr 14, 2016

Copy link
Copy Markdown
MemberAuthor

@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?

@estliberitas
estliberitasforce-pushed the master branch 2 times, most recently from 7da4fd4 to c7066fbCompareApril 26, 2016 05:23
@Fishrock123

Fishrock123 commented Apr 28, 2016

Copy link
Copy Markdown
Contributor

don't land this, see https://github.com/nodejs/node/pull/6436/files#r61430203

@Fishrock123Fishrock123 mentioned this pull request Apr 28, 2016
Closed
3 tasks
@Fishrock123Fishrock123 added the wip Issues and PRs that are still a work in progress. label Apr 28, 2016
@bengl

bengl commented May 6, 2016

Copy link
Copy Markdown
MemberAuthor

@Fishrock123 It looks like #6436 has been updated and no longer collides with this one.

I'll rebase though.

@bengl
doc: add timer classes
f26db5b
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
@Fishrock123Fishrock123 removed the wip Issues and PRs that are still a work in progress. label May 6, 2016
@Fishrock123Fishrock123 mentioned this pull request May 24, 2016
Closed
2 tasks
@benglbengl mentioned this pull request May 27, 2016
Closed
@bengl

bengl commented Jun 6, 2016

Copy link
Copy Markdown
MemberAuthor

Closing as this is now part of #6937

@benglbengl closed this Jun 6, 2016
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

docIssues and PRs related to the documentations.timersIssues 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.

2 participants

@bengl@Fishrock123