doc: add topic - event loop, timers, `nextTick()` #4936

techjeffharris · 2016-01-28T23:23:01Z

This is a ~~rough~~ draft of a Topic that provides an
overview of the event loop, timers, and process.nextTick() that is
based upon a NodeSource "Need to Node" presentation hosted by
@trevnorris: Event Scheduling and the Node.js Event Loop.

I'm sure there's room for improvement, but this is a start!

PTAL

/cc @nodejs/documentation, @nodejs/collaborators

@trevnorris

This is a rough draft of a [Topic](https://github.com/nodejs/docs/blob/master/GETTING-STARTED.md#what-we-write) that provides an overview of the event loop, timers, and `process.nextTick()` that is based upon a NodeSource "Need to Node" presentation hosted by @trevnorris: [Event Scheduling and the Node.js Event Loop](https://nodesource.com/resources).

Qard · 2016-01-28T23:37:59Z

LGTM 👍

chrisdickinson · 2016-01-28T23:40:07Z

Reviewing now — at first glance this looks like great info!

chrisdickinson · 2016-01-28T23:40:28Z

doc/topics/the-event-loop-timers-and-nexttick

@@ -0,0 +1,174 @@
+# Overview of the Event Loop, Timers, and `process.nextTick()`


This file should end with a .md extension.

chrisdickinson · 2016-01-28T23:50:47Z

This is excellent work!

mscdex · 2016-01-28T23:58:08Z

It might be worth mentioning that setImmediate() was introduced in node v0.10? Whereas process.nextTick() has been around for much longer.

techjeffharris · 2016-01-29T00:01:21Z

Thanks for the notes! I must go to my day (evening) job ATM, but I'll address all concerns mentioned ASAP.

Fishrock123 · 2016-01-29T00:55:09Z

@trevnorris should probably review this also as he has previously done detailed analysis of the event loop for presentations and such.

shigeki · 2016-01-29T01:03:26Z

I made a diagram in several years ago for the discussion in https://html5.ohtsu.org/node-v0.11.13-eventloop.png
I hope it can be helpful for understanding for an event loop in libuv.

jasnell · 2016-01-29T06:41:37Z

+1 on this... awesome to see.

ronkorving · 2016-01-29T10:17:52Z

Fantastic work 👍

tomgco · 2016-01-29T10:50:02Z

doc/topics/the-event-loop-timers-and-nexttick

+
+### Why would that be allowed?
+
+Why would something like this be included in Node?  Part of it is a design


@trevnorris

This is a rough draft of a [Topic](https://github.com/nodejs/docs/blob/master/GETTING-STARTED.md#what-we-write) that provides an overview of the event loop, timers, and `process.nextTick()` that is based upon a NodeSource "Need to Node" presentation hosted by @trevnorris: [Event Scheduling and the Node.js Event Loop](https://nodesource.com/resources).

…hjeffharris/node into doc-topic-event-loop-timers-nextTick

techjeffharris · 2016-01-29T19:18:07Z

Pushed some updates to address issues/concerns/suggestions provided above.

calvinmetcalf · 2016-01-29T19:32:31Z

you need to remove the file without the .md

techjeffharris · 2016-01-29T19:33:39Z

thanks! Still a bit of a git novice--learning >_<

techjeffharris · 2016-04-07T22:38:33Z

Okay, I believe I have exhausted my capacity to be the guardian of this PR, and it appears that all major concerns have been addressed. Thanks for all the help!

@nodejs/collaborators, @nodejs/ctc PTAL

mcollina · 2016-04-08T09:48:39Z

LGTM! :)

jasnell · 2016-04-08T15:28:52Z

LGTM
If there's anything additional to be done on this it can be done as separate PRs. Awesome work, thank you!

calvinmetcalf · 2016-04-08T18:12:06Z

landed

Knighton910 · 2016-04-08T18:15:07Z

👍

techjeffharris · 2016-04-08T19:14:49Z

Yay! Thank you all for your help!

@trevnorris

Adds a new topic that provides an overview of the event loop, timers, and `process.nextTick()` that is based upon a NodeSource "Need to Node" presentation hosted by @trevnorris: Event Scheduling and the Node.js Event Loop (https://nodesource.com/resources). PR-URL: #4936 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Calvin W. Metcalf <calvin.metcalf@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>

a0viedo · 2016-04-15T21:06:41Z

Excellent work @techjeffharris!

techjeffharris · 2016-04-16T19:25:13Z

Thank you, @a0viedo !

MylesBorins · 2016-04-19T13:19:43Z

@calvinmetcalf just as a heads up this landed with a bunch of whitespace errors 😢

Applying: doc: add topic - event loop, timers, `nextTick()`
.git/rebase-apply/patch:18: trailing whitespace.
offloading operations to the system kernel whenever possible.
.git/rebase-apply/patch:26: trailing whitespace.
## Event Loop Explained
.git/rebase-apply/patch:48: trailing whitespace.
    │  ┌──────────┴────────────┐      └───────────────┘
.git/rebase-apply/patch:53: trailing whitespace.
       └───────────────────────┘
.git/rebase-apply/patch:81: trailing whitespace.
* `timers`: this phase executes callbacks scheduled by `setTimeout()`
warning: squelched 20 whitespace errors
warning: 25 lines applied after fixing whitespace errors.

If you are running git am you can avoid this by including the flag --whitespace=fix

@trevnorris

Adds a new topic that provides an overview of the event loop, timers, and `process.nextTick()` that is based upon a NodeSource "Need to Node" presentation hosted by @trevnorris: Event Scheduling and the Node.js Event Loop (https://nodesource.com/resources). PR-URL: #4936 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Calvin W. Metcalf <calvin.metcalf@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>

silverwind · 2016-04-19T16:08:04Z

Or even better, use apply-pr, which also does the whitespace fixes.

silverwind · 2016-04-19T16:12:13Z

Got to correct myself, apply-pr does no whitespace fixing by itself, but having

git config --global apply.whitespace fix

does so, and works for both apply-pr and git am 😉

@trevnorris

Adds a new topic that provides an overview of the event loop, timers, and `process.nextTick()` that is based upon a NodeSource "Need to Node" presentation hosted by @trevnorris: Event Scheduling and the Node.js Event Loop (https://nodesource.com/resources). PR-URL: #4936 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Calvin W. Metcalf <calvin.metcalf@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>

@trevnorris

Adds a new topic that provides an overview of the event loop, timers, and `process.nextTick()` that is based upon a NodeSource "Need to Node" presentation hosted by @trevnorris: Event Scheduling and the Node.js Event Loop (https://nodesource.com/resources). PR-URL: #4936 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Calvin W. Metcalf <calvin.metcalf@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>

@trevnorris

Adds a new topic that provides an overview of the event loop, timers, and `process.nextTick()` that is based upon a NodeSource "Need to Node" presentation hosted by @trevnorris: Event Scheduling and the Node.js Event Loop (https://nodesource.com/resources). PR-URL: #4936 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Calvin W. Metcalf <calvin.metcalf@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>

mscdex added the doc Issues and PRs related to the documentations. label Jan 28, 2016

chrisdickinson reviewed Jan 28, 2016
View reviewed changes

jasnell added the lts-watch-v4.x label Jan 29, 2016

tomgco reviewed Jan 29, 2016
View reviewed changes

techjeffharris added 3 commits January 29, 2016 11:12

corrections suggested in the GitHub PR

dc1b8a5

Merge branch 'doc-topic-event-loop-timers-nextTick' of github.com:tec…

bb5b682

…hjeffharris/node into doc-topic-event-loop-timers-nextTick

techjeffharris mentioned this pull request Jan 29, 2016

Hack node.js internal ... #4931

Closed

removed file without .md extension

ba98380

calvinmetcalf merged commit e67fee0 into nodejs:master Apr 8, 2016

MylesBorins added land-on-v4.x and removed lts-watch-v4.x labels Apr 8, 2016

MylesBorins mentioned this pull request Apr 11, 2016

V4.4.3 proposal #6149

Merged

MylesBorins mentioned this pull request Apr 20, 2016

V5.10.2 proposal #6311

Closed

This was referenced Apr 21, 2016

V5.11.0 proposal #6321

Closed

V5.11.0 proposal #6322

Closed

ChALkeR mentioned this pull request Sep 22, 2016

doc: enable no-file-name-articles remark-lint rule and rename doc/topics/the-event-loop-timers-and-nexttick.md #8713

Closed

3 tasks

gibfahn mentioned this pull request Jan 7, 2018

One mistake in the article of guides nodejs/nodejs.org#1542

Closed

vsemozhetbyt mentioned this pull request Feb 27, 2018

How the event loop works nodejs/help#1118

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: add topic - event loop, timers, `nextTick()` #4936

doc: add topic - event loop, timers, `nextTick()` #4936

techjeffharris commented Jan 28, 2016

Qard commented Jan 28, 2016

chrisdickinson commented Jan 28, 2016

chrisdickinson Jan 28, 2016

techjeffharris Jan 28, 2016

chrisdickinson commented Jan 28, 2016

mscdex commented Jan 28, 2016

techjeffharris commented Jan 29, 2016

Fishrock123 commented Jan 29, 2016

shigeki commented Jan 29, 2016

jasnell commented Jan 29, 2016

ronkorving commented Jan 29, 2016

tomgco Jan 29, 2016

techjeffharris commented Jan 29, 2016

calvinmetcalf commented Jan 29, 2016

techjeffharris commented Jan 29, 2016

techjeffharris commented Apr 7, 2016

mcollina commented Apr 8, 2016

jasnell commented Apr 8, 2016

calvinmetcalf commented Apr 8, 2016

Knighton910 commented Apr 8, 2016

techjeffharris commented Apr 8, 2016

a0viedo commented Apr 15, 2016

techjeffharris commented Apr 16, 2016

MylesBorins commented Apr 19, 2016

silverwind commented Apr 19, 2016

silverwind commented Apr 19, 2016 •

edited

Loading

		@@ -0,0 +1,174 @@
		# Overview of the Event Loop, Timers, and `process.nextTick()`


		### Why would that be allowed?

		Why would something like this be included in Node? Part of it is a design

doc: add topic - event loop, timers, nextTick() #4936

doc: add topic - event loop, timers, nextTick() #4936

Conversation

techjeffharris commented Jan 28, 2016

Qard commented Jan 28, 2016

chrisdickinson commented Jan 28, 2016

chrisdickinson Jan 28, 2016

Choose a reason for hiding this comment

techjeffharris Jan 28, 2016

Choose a reason for hiding this comment

chrisdickinson commented Jan 28, 2016

mscdex commented Jan 28, 2016

techjeffharris commented Jan 29, 2016

Fishrock123 commented Jan 29, 2016

shigeki commented Jan 29, 2016

jasnell commented Jan 29, 2016

ronkorving commented Jan 29, 2016

tomgco Jan 29, 2016

Choose a reason for hiding this comment

techjeffharris commented Jan 29, 2016

calvinmetcalf commented Jan 29, 2016

techjeffharris commented Jan 29, 2016

techjeffharris commented Apr 7, 2016

mcollina commented Apr 8, 2016

jasnell commented Apr 8, 2016

calvinmetcalf commented Apr 8, 2016

Knighton910 commented Apr 8, 2016

techjeffharris commented Apr 8, 2016

a0viedo commented Apr 15, 2016

techjeffharris commented Apr 16, 2016

MylesBorins commented Apr 19, 2016

silverwind commented Apr 19, 2016

silverwind commented Apr 19, 2016 • edited Loading

doc: add topic - event loop, timers, `nextTick()` #4936

doc: add topic - event loop, timers, `nextTick()` #4936

silverwind commented Apr 19, 2016 •

edited

Loading