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

V4.4.3 proposal #6149

Merged
merged 53 commits into from
Apr 12, 2016
Merged
Changes from 1 commit
Commits
Show all changes
53 commits
Select commit Hold shift + click to select a range
200f763
deps: completely upgrade npm in LTS to 2.15.1
othiym23 Apr 1, 2016
4f683ab
src,tools: use template literals
Trott Mar 18, 2016
ea83c38
test: ensure win32.isAbsolute() is consistent
mscdex Apr 3, 2016
feedca7
doc: add topic - event loop, timers, `nextTick()`
techjeffharris Apr 8, 2016
56dda6f
fs: Remove unused branches
benjamingr Mar 22, 2016
505faf6
doc: refine child_process detach behaviour
eljefedelrodeodeljefe Feb 19, 2016
16216a8
meta: add "joining a wg" section to WORKING_GROUPS.md
mcollina Feb 29, 2016
aadf356
deps: backport 8d00c2c from v8 upstream
bnoordhuis Mar 6, 2016
6d3822c
etw: fix descriptors of events 9 and 23
joaocgreis Mar 16, 2016
c4103b1
lib: refactor code with startsWith/endsWith
JacksonTian Mar 17, 2016
940d204
doc: consolidate timers docs in timers.markdown
bengl Mar 21, 2016
86e3903
dns: Use object without protoype for map
benjamingr Mar 22, 2016
5853fec
test: fix test-debugger-client.js
Trott Mar 22, 2016
e0b283a
test: fix flaky test-http-set-timeout
Trott Mar 23, 2016
d275cdf
child_process: refactor self=this in socket_list
benjamingr Mar 23, 2016
6e2bfbe
doc: fix doc for Buffer.readInt32LE()
ghaiklor Mar 24, 2016
8462d8f
test: fix flaky test-net-socket-timeout
mscdex Mar 24, 2016
a0a2e69
test: move dns test to test/internet
bnoordhuis Mar 25, 2016
9702153
test: fix flaky test-repl
mscdex Mar 25, 2016
aed22d0
doc: path.format provide more examples
eversojk Mar 22, 2016
65fc4e3
querystring: don't stringify bad surrogate pair
mscdex Mar 23, 2016
02401a6
doc: fix scrolling on iOS devices
lpinca Mar 23, 2016
d59be4d
test: ensure _handle property existence
Trott Mar 26, 2016
9a8f922
build: add missing `openssl_fips%` to common.gypi
indutny Mar 27, 2016
fe0233b
test: add known_issues test for GH-2148
Trott Mar 27, 2016
132acea
build: introduce ci targets for lint/benchmark
jbergstroem Mar 27, 2016
f60ce10
doc: document unspecified behavior for buf.write* methods
jasnell Mar 27, 2016
63d8296
test: stdin is not always a net.Socket
Fishrock123 Mar 28, 2016
10fe79b
test: fix offending max-len linter error
thefourtheye Mar 31, 2016
cc1aab9
test: mitigate flaky test-https-agent
Trott Mar 28, 2016
c33a23f
tools: fix json doc generation
firedfox Mar 29, 2016
1994ac0
test: add test for piping large input from stdin
addaleax Mar 29, 2016
6f0bd64
tools,doc: fix incomplete json produced by doctool
firedfox Mar 31, 2016
ccf90b6
test: fix test-dns.js flakiness
Trott Apr 1, 2016
a39051f
test: make arch available in status files
santigimeno Apr 1, 2016
f949c27
assert: Check typed array view type in deepEqual
addaleax Mar 26, 2016
f9cf232
doc: add example using algorithms not directly exposed
hillbrad Apr 7, 2016
c91f3d8
doc: add copy about how to curl SHA256.txt
Apr 8, 2016
e7877e6
test: fix flaky test-net-socket-timeout-unref
Trott Mar 29, 2016
bb603b8
doc: add 'Command Line Options' to 'View on single page'
firedfox Apr 2, 2016
73e3b7b
test: make use of globals explicit
Trott Apr 2, 2016
56755de
doc: clarify stdout/stderr arguments to callback
jasnell Apr 2, 2016
a7b3a75
test: be explicit about polluting of `global`
Trott Apr 2, 2016
0870ac6
doc: use HTTPS for links where possible
Trott Apr 2, 2016
ac40a45
test: explicitly set global in test-repl
Trott Apr 3, 2016
8c2befe
doc: note assert.throws() pitfall
Trott Apr 3, 2016
f16802f
doc: note about Android support
Trott Apr 4, 2016
86d2af5
doc: simple doc typo fix
BrendonPierson Apr 4, 2016
f7eb483
win,build: build and test add-ons on test-ci
Mar 24, 2016
dfe9e15
governance: remove target size for CTC
Trott Mar 23, 2016
9679e2d
doc: clarify that __dirname is module local
jasnell Apr 2, 2016
9a33f43
doc: update openssl LICENSE using license-builder.sh
srl295 Apr 5, 2016
d7f2bc9
2016-04-12, Version 4.4.3 'Argon' (LTS)
Apr 11, 2016
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
doc: consolidate timers docs in timers.markdown
Rather than attempting to keep two versions of docs for timers up to
date, keep them in timers.markdown, and leave references to them in
globals.markdown.

Add setImmediate and clearImmediate to globals.markdown.

Change "To schedule" to "Schedules" in timers.markdown.

PR-URL: #5837
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
bengl authored and Myles Borins committed Apr 8, 2016
commit 940d2044013ef3014624eb3192cd02b913298484
51 changes: 27 additions & 24 deletions doc/api/globals.markdown
Original file line number Diff line number Diff line change
@@ -50,19 +50,23 @@ console.log(__filename);

`__filename` isn't actually a global but rather local to each module.

## clearInterval(t)
## clearImmediate(immediateObject)

Stop a timer that was previously created with [`setInterval()`][]. The callback
will not execute.
<!--type=global-->

[`clearImmediate`] is described in the [timers][] section.

## clearInterval(intervalObject)

<!--type=global-->

The timer functions are global variables. See the [timers][] section.
[`clearInterval`] is described in the [timers][] section.

## clearTimeout(t)
## clearTimeout(timeoutObject)

<!--type=global-->

Stop a timer that was previously created with [`setTimeout()`][]. The callback will
not execute.
[`clearTimeout`] is described in the [timers][] section.

## console

@@ -162,34 +166,33 @@ left untouched.
Use the internal `require()` machinery to look up the location of a module,
but rather than loading the module, just return the resolved filename.

## setInterval(cb, ms)
## setImmediate(callback[, arg][, ...])

Run callback `cb` repeatedly every `ms` milliseconds. Note that the actual
interval may vary, depending on external factors like OS timer granularity and
system load. It's never less than `ms` but it may be longer.
<!-- type=global -->

[`setImmediate`] is described in the [timers][] section.

The interval must be in the range of 1-2,147,483,647 inclusive. If the value is
outside that range, it's changed to 1 millisecond. Broadly speaking, a timer
cannot span more than 24.8 days.
## setInterval(callback, delay[, arg][, ...])

Returns an opaque value that represents the timer.
<!-- type=global -->

## setTimeout(cb, ms)
[`setInterval`] is described in the [timers][] section.

Run callback `cb` after *at least* `ms` milliseconds. The actual delay depends
on external factors like OS timer granularity and system load.
## setTimeout(callback, delay[, arg][, ...])

The timeout must be in the range of 1-2,147,483,647 inclusive. If the value is
outside that range, it's changed to 1 millisecond. Broadly speaking, a timer
cannot span more than 24.8 days.
<!-- type=global -->

Returns an opaque value that represents the timer.
[`setTimeout`] is described in the [timers][] section.

[`console`]: console.html
[`process` object]: process.html#process_process
[`setInterval()`]: #globals_setinterval_cb_ms
[`setTimeout()`]: #globals_settimeout_cb_ms
[buffer section]: buffer.html
[module system documentation]: modules.html
[Modules]: modules.html#modules_modules
[timers]: timers.html
[`clearImmediate`]: timers.html#timers_clearimmediate_immediateobject
[`clearInterval`]: timers.html#timers_clearinterval_intervalobject
[`clearTimeout`]: timers.html#timers_cleartimeout_timeoutobject
[`setImmediate`]: timers.html#timers_setimmediate_callback_arg
[`setInterval`]: timers.html#timers_setinterval_callback_delay_arg
[`setTimeout`]: timers.html#timers_settimeout_callback_delay_arg
6 changes: 3 additions & 3 deletions doc/api/timers.markdown
Original file line number Diff line number Diff line change
@@ -27,7 +27,7 @@ Returns the timer.

## setImmediate(callback[, arg][, ...])

To schedule the "immediate" execution of `callback` after I/O events'
Schedules "immediate" execution of `callback` after I/O events'
callbacks and before timers set by [`setTimeout`][] and [`setInterval`][] are
triggered. Returns an `immediateObject` for possible use with
[`clearImmediate`][]. Additional optional arguments may be passed to the
@@ -40,7 +40,7 @@ until the next event loop iteration.

## setInterval(callback, delay[, arg][, ...])

To schedule the repeated execution of `callback` every `delay` milliseconds.
Schedules repeated execution of `callback` every `delay` milliseconds.
Returns a `intervalObject` for possible use with [`clearInterval`][]. Additional
optional arguments may be passed to the callback.

@@ -50,7 +50,7 @@ milliseconds (approximately 25 days) or less than 1, Node.js will use 1 as the

## setTimeout(callback, delay[, arg][, ...])

To schedule execution of a one-time `callback` after `delay` milliseconds.
Schedules execution of a one-time `callback` after `delay` milliseconds.
Returns a `timeoutObject` for possible use with [`clearTimeout`][]. Additional
optional arguments may be passed to the callback.