Lance Ball 23818c6d0b doc: correctly document the behavior of ee.once(). ...

Addresses #5566. The `ee.once()` function is currently documented as
invoking the listener, and then removing it when the event is
triggered. However, this is not really the case. The listener is removed
and _then_ invoked. This only matters in a narrow set of use cases, but
when it matters, it matters that the docs are correct.

See the issue (#5566) for a discussion on why the code has not been
modified to match the documentation, but instead the documentation has
been modified to match the code.

Fixes: https://github.com/nodejs/node/issues/5566
PR-URL: https://github.com/nodejs/node/pull/6371
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Robert Lindstaedt <robert.lindstaedt@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com>

2016-04-26 22:49:37 -07:00

..

_toc.md

doc: git mv to .md

2016-04-20 16:34:27 -07:00

addons.md

doc: git mv to .md

2016-04-20 16:34:27 -07:00

all.md

doc: git mv to .md

2016-04-20 16:34:27 -07:00

assert.md

doc: git mv to .md

2016-04-20 16:34:27 -07:00

buffer.md

buffer: add Buffer.prototype.lastIndexOf()

2016-04-25 08:24:28 -07:00

child_process.md

doc: fix broken references

2016-04-22 19:08:48 -07:00

cli.md

doc: git mv to .md

2016-04-20 16:34:27 -07:00

cluster.md

cluster: migrate from worker.suicide

2016-04-25 19:24:37 -05:00

console.md

doc: git mv to .md

2016-04-20 16:34:27 -07:00

crypto.md

doc: use Buffer.from() instead of new Buffer()

2016-04-27 13:23:41 +08:00

debugger.md

doc: git mv to .md

2016-04-20 16:34:27 -07:00

dgram.md

doc: use Buffer.from() instead of new Buffer()

2016-04-27 13:23:41 +08:00

dns.md

doc: git mv to .md

2016-04-20 16:34:27 -07:00

documentation.md

doc: git mv to .md

2016-04-20 16:34:27 -07:00

domain.md

doc: git mv to .md

2016-04-20 16:34:27 -07:00

errors.md

doc: git mv to .md

2016-04-20 16:34:27 -07:00

events.md

doc: correctly document the behavior of ee.once().

2016-04-26 22:49:37 -07:00

fs.md

doc: fix position of fs.readSync()

2016-04-26 12:55:56 -04:00

globals.md

doc: git mv to .md

2016-04-20 16:34:27 -07:00

http.md

doc: git mv to .md

2016-04-20 16:34:27 -07:00

https.md

doc: git mv to .md

2016-04-20 16:34:27 -07:00

index.md

doc: git mv to .md

2016-04-20 16:34:27 -07:00

modules.md

doc: git mv to .md

2016-04-20 16:34:27 -07:00

net.md

net: introduce Socket#connecting property

2016-04-27 00:41:15 -04:00

os.md

doc: git mv to .md

2016-04-20 16:34:27 -07:00

path.md

doc: git mv to .md

2016-04-20 16:34:27 -07:00

process.md

doc: fix broken references

2016-04-22 19:08:48 -07:00

punycode.md

doc: git mv to .md

2016-04-20 16:34:27 -07:00

querystring.md

doc: git mv to .md

2016-04-20 16:34:27 -07:00

readline.md

readline: allow history to be disabled

2016-04-26 02:31:05 +02:00

repl.md

doc: git mv to .md

2016-04-20 16:34:27 -07:00

stream.md

doc: use Buffer.from() instead of new Buffer()

2016-04-27 13:23:41 +08:00

string_decoder.md

doc: use Buffer.from() instead of new Buffer()

2016-04-27 13:23:41 +08:00

synopsis.md

doc: git mv to .md

2016-04-20 16:34:27 -07:00

timers.md

doc: git mv to .md

2016-04-20 16:34:27 -07:00

tls.md

doc, tls: deprecate createSecurePair

2016-04-26 09:05:12 -07:00

tty.md

doc: git mv to .md

2016-04-20 16:34:27 -07:00

url.md

doc: git mv to .md

2016-04-20 16:34:27 -07:00

util.md

doc: use Buffer.from() instead of new Buffer()

2016-04-27 13:23:41 +08:00

v8.md

doc: git mv to .md

2016-04-20 16:34:27 -07:00

vm.md

doc: add vm example, be able to require modules

2016-04-21 21:44:41 -07:00

zlib.md

doc: use Buffer.from() instead of new Buffer()

2016-04-27 13:23:41 +08:00