Doc: Adding guide on Timers #6825

ryanmurakami · 2016-05-18T00:46:45Z

Checklist

the commit message follows commit guidelines

Affected core subsystem(s)

doc

Description of change

Adding guide of using Timers in Node per nodejs/docs#76.

Fishrock123 · 2016-05-18T01:38:38Z

doc/guides/timers-in-node.md

+setTimeout(myFunc, 1500);
+```
+
+The above function ```myFunc()``` will execute after approximately 1500 milliseconds (or 1.5 seconds) due to the call of ```setTimeout()```.


Inline code blocks should be surrounded single backticks

jasnell · 2016-05-18T03:47:57Z

@nodejs/documentation

ryanmurakami · 2016-05-18T04:10:18Z

@Fishrock123 Thanks for the feedback! I've fixed it.

Fishrock123 · 2016-05-18T14:07:59Z

doc/guides/timers-in-node.md

+
+`setImmediate()` allows you to execute code at the beginning of the next event loop cycle. This code will execute *before* any timers or IO operations. I like to think of this code execution as happening "right after this", meaning any code following the `setImmediate()` function call will execute before the `setImmediate()` function argument. Here's an example:
+
+```javascript


can be ```js

Fishrock123 · 2016-05-18T14:08:46Z

I think we'd probably better with clearer heading names. I'll try to give this more review later this week.

thefourtheye · 2016-05-18T15:01:22Z

I see a lot of long lines. Can you wrap them at 80 chars please?

ryanmurakami · 2016-05-18T18:02:40Z

@thefourtheye done, thanks!
@Fishrock123 I'll rework them a bit. I'd like to keep the "personality" but can add a little more specific info for each. Thanks for the feedback.

thefourtheye · 2016-05-18T18:35:54Z

doc/guides/timers-in-node.md

+The timeout interval that is set cannot be relied upon to execute after 
+that *exact* number of milliseconds. This is because executing code that 
+blocks or holds onto the event loop will push the execution of your timeout 
+back. You *can* guarantee that your timeout will not execute *sooner* than 


timeout function will not execute?

meaning, it won't execute sooner than the timeout, it will execute on or after the timeout.

thefourtheye · 2016-05-18T18:45:52Z

I liked what I read. Thanks :-)

jasnell · 2016-05-18T19:15:03Z

doc/guides/timers-in-node.md

+
+Timers are a collection of global functions in node.js that allow you to 
+execute code after a set period of time. To fully understand when timer 
+functions will be executed, it's a good idea to read up on the the node 


s/node/Node.js (here and everywhere else it's mentioned ;-) )

ryanmurakami · 2016-06-29T15:26:13Z

@Fishrock123 Cool! So, I looked at revising that sentence, but I think the way process.nextTick() is executed is already well explained in the guide I link to, so I just placed a direct link to that section. I agree it was getting too confusing and trying to explain what's happening would've taken too much.

Also, removed deja vu. Good point about it possibly being unfamiliar to readers.

Thanks again for the feedback!

jasnell · 2016-06-29T22:48:35Z

doc/guides/timers-in-node.md

@@ -94,11 +94,11 @@ some major ways they differ. The first is that `process.nextTick()` will run
 *before* any `Immediate`s that are set as well as before any scheduled I/O.
 The second is that `process.nextTick()` is non-clearable, meaning once
 code has been scheduled to execute with `process.nextTick()`, the execution


Perhaps...

Refer to [this guide][../topics/the-event-loop-timers-and-nexttick#processnexttick] to better understand the operation of `process.nextTick()`.

sure, sounds good.

thefourtheye · 2016-06-30T02:54:38Z

doc/guides/timers-in-node.md

+
+## Controlling the Time Continuum with Node.js
+
+The Node.js API provides several ways to of scheduling code to execute at


ways to schedule/ways of scheduling

thefourtheye · 2016-06-30T03:12:09Z

LGTM - comments

ryanmurakami · 2016-06-30T04:33:31Z

@thefourtheye Thanks for your comments! Good catches! I've updated them and added a note on the differences with window.setTimeout().

Fishrock123 · 2016-06-30T08:58:53Z

doc/guides/timers-in-node.md

+### "When I say so" Execution ~ *`setTimeout()`*
+
+`setTimeout()` can be used to schedule code execution after a designated
+amount of milliseconds. This function is similar to `window.setTimeout()`


Link window.setTimeout() to https://developer.mozilla.org/en-US/docs/Web/API/WindowTimers/setTimeout?

If you don't, I'll do it upon landing.

Got it. Added.

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 · 2016-07-01T17:04:26Z

Looks like there are some whitespace errors, could you please set git config --global --add core.whitespace fix for next time?

Thanks though, squashed and landed in 1299c27 with some nits!

Fishrock123 · 2016-07-01T17:05:38Z

(Also, since I think this was your first PR to core, welcome! Hopefully the journey to get this in wasn't too much haha.)

ryanmurakami · 2016-07-01T19:19:18Z

@Fishrock123 Yay! Thanks for the welcome! Thanks for all your help, I really learned a ton. Looking forward to future contributions!

Knighton910 · 2016-07-01T23:55:10Z

Awesome work :)

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>

MylesBorins · 2016-07-12T00:04:31Z

I've added the dont-land label for v4.x assuming that this is built on a more modern version of the timers api. Please let me know if this assumption is incorrect

ryanmurakami added 2 commits May 17, 2016 17:39

Merge remote-tracking branch 'nodejs/master'

1c0f9ad

moving timer guide to core

c73869c

nodejs-github-bot added the doc Issues and PRs related to the documentations. label May 18, 2016

Fishrock123 self-assigned this May 18, 2016

Fishrock123 reviewed May 18, 2016
View reviewed changes

mscdex added the timers Issues and PRs related to the timers subsystem / setImmediate, setInterval, setTimeout. label May 18, 2016

Changing inline code blocks to single backticks

e419e50

Fishrock123 reviewed May 18, 2016
View reviewed changes

shortening code block syntax & shortening lines

291d1aa

thefourtheye reviewed May 18, 2016
View reviewed changes

jasnell reviewed May 18, 2016
View reviewed changes

ryanmurakami added 3 commits June 29, 2016 08:32

Merge remote-tracking branch 'nodejs/master'

020b941

grammar revisions in process.nextTick()

20c55c0

s-s-s-spaces

0fb1eeb

jasnell reviewed Jun 29, 2016
View reviewed changes

Revising link to guide sentence

14a644f

thefourtheye reviewed Jun 30, 2016
View reviewed changes

ryanmurakami added 3 commits June 29, 2016 20:37

Merge branch 'master' of https://github.com/ryanmurakami/node

9377403

rolling back whoops change

2f78f5f

feedback

f7fa1a9

Fishrock123 reviewed Jun 30, 2016
View reviewed changes

Adding link to MDN docs for window.setTimeout()

afa5167

Fishrock123 closed this Jul 1, 2016

Fishrock123 mentioned this pull request Jul 1, 2016

docs: Document Timers in Node nodejs/docs#76

Closed

Fishrock123 mentioned this pull request Jul 5, 2016

Propose v6.3.0 (v2) #7550

Merged

MylesBorins mentioned this pull request Jul 11, 2016

Audit commits not found on v4.x-staging #7661

Closed

MylesBorins added the dont-land-on-v4.x label Jul 12, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Doc: Adding guide on Timers #6825

Doc: Adding guide on Timers #6825

ryanmurakami commented May 18, 2016

Fishrock123 May 18, 2016

jasnell commented May 18, 2016

ryanmurakami commented May 18, 2016

Fishrock123 May 18, 2016

Fishrock123 commented May 18, 2016

thefourtheye commented May 18, 2016

ryanmurakami commented May 18, 2016

thefourtheye May 18, 2016

ryanmurakami May 19, 2016

thefourtheye commented May 18, 2016

jasnell May 18, 2016 •

edited

Loading

ryanmurakami May 19, 2016

ryanmurakami commented Jun 29, 2016

jasnell Jun 29, 2016

ryanmurakami Jun 29, 2016

thefourtheye Jun 30, 2016

thefourtheye commented Jun 30, 2016

ryanmurakami commented Jun 30, 2016

Fishrock123 Jun 30, 2016

ryanmurakami Jun 30, 2016

Fishrock123 commented Jul 1, 2016

Fishrock123 commented Jul 1, 2016

ryanmurakami commented Jul 1, 2016

Knighton910 commented Jul 1, 2016

MylesBorins commented Jul 12, 2016


		`setImmediate()` allows you to execute code at the beginning of the next event loop cycle. This code will execute before any timers or IO operations. I like to think of this code execution as happening "right after this", meaning any code following the `setImmediate()` function call will execute before the `setImmediate()` function argument. Here's an example:

		```javascript


		## Controlling the Time Continuum with Node.js

		The Node.js API provides several ways to of scheduling code to execute at

Doc: Adding guide on Timers #6825

Doc: Adding guide on Timers #6825

Conversation

ryanmurakami commented May 18, 2016

Checklist

Affected core subsystem(s)

Description of change

Choose a reason for hiding this comment

jasnell commented May 18, 2016

ryanmurakami commented May 18, 2016

Choose a reason for hiding this comment

Fishrock123 commented May 18, 2016

thefourtheye commented May 18, 2016

ryanmurakami commented May 18, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thefourtheye commented May 18, 2016

jasnell May 18, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ryanmurakami commented Jun 29, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thefourtheye commented Jun 30, 2016

ryanmurakami commented Jun 30, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Fishrock123 commented Jul 1, 2016

Fishrock123 commented Jul 1, 2016

ryanmurakami commented Jul 1, 2016

Knighton910 commented Jul 1, 2016

MylesBorins commented Jul 12, 2016

jasnell May 18, 2016 •

edited

Loading