Skip to content
This repository has been archived by the owner on Mar 25, 2018. It is now read-only.

docs: Document Timers in Node #76

Closed
ryanmurakami opened this issue Feb 5, 2016 · 11 comments · Fixed by #108
Closed

docs: Document Timers in Node #76

ryanmurakami opened this issue Feb 5, 2016 · 11 comments · Fixed by #108

Comments

@ryanmurakami
Copy link

This will track progress on a Documentation Overview of Timers in Node, as suggested in the Docs WG Roadmap for Q1 2016 (#70). Since an understanding of the Event Loop is pretty essential to giving context for timers, I'll be using nodejs/node#4936 as a branching off point to explain how timers work and best usages of the different API functions.

Here are some ideas I have for topics to cover:
Differences between intervalObject and timeoutObject and how they wrap Timer objects
Timer internals, like the linked list structure
... more to add

Any suggestions for topics are appreciated!

@stevemao
Copy link
Contributor

stevemao commented Feb 5, 2016

related: #48 #34

@chrisdickinson
Copy link
Contributor

Excellent! I've added this issue and your name to the roadmap. Thanks!

@ryanmurakami
Copy link
Author

Opened a PR for the first draft: nodejs/nodejs.org#718

Also, not really sure if this is the right place to drop this guide? One of the other guides was created as a topic and dropped in node core. Let me know if this isn't the best place. Thanks!

Fishrock123 pushed a commit to nodejs/node that referenced this issue Jul 1, 2016
Refs: nodejs/docs#76
PR-URL: #6825
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
@Fishrock123
Copy link

The PR landed at nodejs/node#6825 🎉

@Knighton910
Copy link

awesome 😄

@stevemao
Copy link
Contributor

stevemao commented Jul 2, 2016

Can we close this?

@Knighton910
Copy link

Knighton910 commented Jul 2, 2016

the issue has landed, i don't see why not. Plus we need a pr to update the docs Roadmap on this

@stevemao do you want to make that PR or should i?

stevemao added a commit that referenced this issue Jul 2, 2016
@stevemao
Copy link
Contributor

stevemao commented Jul 2, 2016

#108

@ryanmurakami
Copy link
Author

@lordKnighton @stevemao Thanks guys! Also, the event loop guide has been completed & merged as well by @techjeffharris. You can probably remove that line from the Roadmap also.

@Knighton910
Copy link

Cool 🎱 again though, awesome work.

stevemao added a commit that referenced this issue Jul 2, 2016
@stevemao
Copy link
Contributor

stevemao commented Jul 2, 2016

PR is updated :)

Fishrock123 pushed a commit to nodejs/node that referenced this issue Jul 5, 2016
Refs: nodejs/docs#76
PR-URL: #6825
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants