Sam Ruby
40c85ff063
doc: declare all parameter types
...
PR-URL: https://github.com/nodejs/node/pull/21782
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com >
2018-07-15 23:57:35 +03:00
Rich Trott
1252907c6c
doc: simplify deprecation language
...
Change instances of `foo has been deprecated` to `foo is deprecated` and
similar.
PR-URL: https://github.com/nodejs/node/pull/21136
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
Reviewed-By: Michaël Zasso <targos@protonmail.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com >
2018-06-06 21:06:13 -07:00
daGo
2d945fd645
doc: clarify this in event listeners
...
this === eventEmitter or this === instance of EventEmitter,
but it's this is not EventEmitter.
PR-URL: https://github.com/nodejs/node/pull/20537
Reviewed-By: Anna Henningsen <anna@addaleax.net >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com >
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com >
2018-05-08 13:28:38 +03:00
Jesse W. Collins
271fdf80f6
doc: excise "periodically" before "emit events"
...
"periodically" implies regular time intervals between emitted events,
but as first example, "peer connects", implies, the time intervals
may be irregular or unpredictable.
PR-URL: https://github.com/nodejs/node/pull/20581
Reviewed-By: Anna Henningsen <anna@addaleax.net >
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com >
2018-05-07 23:12:55 +03:00
Vse Mozhet Byt
7588ceaf35
doc: add more missing backticks
...
Also, fix some other nits in passing
(formatting, punctuation, typos, redundancy, obsoleteness).
PR-URL: https://github.com/nodejs/node/pull/20438
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
2018-05-03 02:12:07 +03:00
Vse Mozhet Byt
a3bd06a5e6
doc: remove redundant empty lines
...
PR-URL: https://github.com/nodejs/node/pull/20398
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com >
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de >
2018-04-29 17:48:43 +03:00
Ajido
1e40b75404
doc: add emitter.off() to events.md
...
PR-URL: https://github.com/nodejs/node/pull/20291
Refs: https://github.com/nodejs/node/pull/17156
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com >
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com >
Reviewed-By: Anna Henningsen <anna@addaleax.net >
2018-04-25 19:55:53 +03:00
Vse Mozhet Byt
9c8857d946
doc: add quotes for event names + fix similar nits
...
PR-URL: https://github.com/nodejs/node/pull/19915
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
2018-04-11 21:42:38 -07:00
Vse Mozhet Byt
df5d41bf93
doc: add and unify even more return values
...
PR-URL: https://github.com/nodejs/node/pull/19955
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de >
Reviewed-By: James M Snell <jasnell@gmail.com >
2018-04-12 03:18:01 +03:00
estrada9166
a29089d7c8
doc: add new documentation lint rule
...
Add 80 characters limit to docs.
Change docs to fit 80 characters per row.
PR-URL: https://github.com/nodejs/node/pull/18726
Fixes: https://github.com/nodejs/node/issues/18703
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de >
Reviewed-By: Matteo Collina <matteo.collina@gmail.com >
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com >
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com >
2018-02-23 16:26:29 +00:00
Myles Borins
e688175c50
2019-01-10 Version 9.4.0 (Current)
...
Notable change:
* async_hooks:
- deprecate AsyncHooks Sensitive API and runInAsyncIdScope. Neither
API were documented. (Andreas Madsen)
https://github.com/nodejs/node/pull/16972
* deps:
- update nghttp2 to 1.29.0 (James M Snell)
https://github.com/nodejs/node/pull/17908
- upgrade npm to 5.6.0 (Kat Marchán)
https://github.com/nodejs/node/pull/17535
- cherry-pick 50f7455 from upstream V8 (Michaël Zasso)
https://github.com/nodejs/node/pull/16591
* events:
- remove reaches into _events internals (Anatoli Papirovski)
https://github.com/nodejs/node/pull/17440
* http:
- add rawPacket in err of `clientError` event (XadillaX)
https://github.com/nodejs/node/pull/17672
* http2:
- implement maxSessionMemory (James M Snell)
https://github.com/nodejs/node/pull/17967
- add initial support for originSet (James M Snell)
https://github.com/nodejs/node/pull/17935
- add altsvc support (James M Snell)
https://github.com/nodejs/node/pull/17917
- perf_hooks integration (James M Snell)
https://github.com/nodejs/node/pull/17906
- Refactoring and cleanup of Http2Session and Http2Stream destroy
(James M Snell) https://github.com/nodejs/node/pull/17406
* net:
- remove Socket.prototype.write (Anna Henningsen)
https://github.com/nodejs/node/pull/17644
- remove Socket.prototype.listen (Ruben Bridgewater)
https://github.com/nodejs/node/pull/13735
* repl:
- show lexically scoped vars in tab completion (Michaël Zasso)
https://github.com/nodejs/node/pull/16591
* stream:
- rm {writeable/readable}State.length (Calvin Metcalf)
https://github.com/nodejs/node/pull/12857
- add flow and buffer properties to streams (Calvin Metcalf)
https://github.com/nodejs/node/pull/12855
* util:
- allow wildcards in NODE_DEBUG variable (Tyler)
https://github.com/nodejs/node/pull/17609
* zlib:
- add ArrayBuffer support (Jem Bezooyen)
https://github.com/nodejs/node/pull/16042
* Addedew collaborator**
- [starkwang](https://github.com/starkwang ) Weijia Wang
* Addedew TSC member**
- [danbev](https://github.com/danbev ) Daniel Bevenius
PR-URL: https://github.com/nodejs/node/pull/18069
2018-01-10 10:24:22 -05:00
April Webster
b2432a7f00
doc: change eventName type annotations
...
Change type annotations for eventName in events API doc
from {any} to {string|symbol}.
PR-URL: https://github.com/nodejs/node/pull/17666
Fixes: https://github.com/nodejs/node/issues/17657
Reviewed-By: Anna Henningsen <anna@addaleax.net >
Reviewed-By: Jon Moss <me@jonathanmoss.me >
Reviewed-By: Timothy Gu <timothygu99@gmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Evan Lucas <evanlucas@me.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com >
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de >
2017-12-17 12:16:58 -05:00
Anatoli Papirovski
decab712ba
events: remove reaches into _events internals
...
Refactor lib & src code to eliminate all deep reaches into the
internal _events dictionary object, instead use available APIs
and add an extra method to EventEmitter: rawListeners.
PR-URL: https://github.com/nodejs/node/pull/17440
Reviewed-By: Anna Henningsen <anna@addaleax.net >
Reviewed-By: Timothy Gu <timothygu99@gmail.com >
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de >
Reviewed-By: Matteo Collina <matteo.collina@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2017-12-14 08:43:00 -05:00
Rich Trott
de06dc92d1
doc: fix common typo involving one-time listeners
...
Our docs use both "one time listener" and "one-time listener". The
second is more correct. Standardize on that.
PR-URL: https://github.com/nodejs/node/pull/17502
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Richard Lau <riclau@uk.ibm.com >
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com >
Reviewed-By: Jon Moss <me@jonathanmoss.me >
Reviewed-By: Minwoo Jung <minwoo@nodesource.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
2017-12-07 13:49:53 -08:00
Luigi Pinca
9531fcbb2e
doc: avoid mentioning 'uncaughtException'
...
Avoid suggesting using `'uncaughtException'` for emitted errors.
PR-URL: https://github.com/nodejs/node/pull/16905
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
2017-11-18 21:07:06 +01:00
gowpen
52e84541fd
doc: correct effects to affects
...
PR-URL: https://github.com/nodejs/node/pull/16794
Fixes: https://github.com/nodejs/node/issues/16793
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Minwoo Jung <minwoo@nodesource.com >
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2017-11-06 03:51:53 -08:00
gowpen
b5f0578692
doc: correct EventEmitter reference
...
PR-URL: https://github.com/nodejs/node/pull/16791
Fixes: https://github.com/nodejs/node/issues/16789
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2017-11-06 03:46:53 -08:00
Chris Young
cacce304cb
doc: add links to alternative versions of doc
...
Each page of the API documentation should have links to other versions
of the same page. This will make it easier to switch between the current
"live" release at nodejs.org and LTS versions.
PR-URL: https://github.com/nodejs/node/pull/10958
Fixes: https://github.com/nodejs/node/issues/10726
Reviewed-By: Refael Ackermann <refack@gmail.com >
Reviewed-By: Evan Lucas <evanlucas@me.com >
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com >
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de >
2017-08-28 11:17:08 +02:00
Alexey Orlenko
2af49b6c89
doc: make the style of notes consistent
...
Make the style of "Note:" paragraphs consistent and document the
guidelines in `doc/STYLE_GUIDE.md`.
PR-URL: https://github.com/nodejs/node/pull/13133
Fixes: https://github.com/nodejs/node/issues/13131
Reviewed-By: Refael Ackermann <refack@gmail.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com >
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Sam Roberts <vieuxtech@gmail.com >
2017-05-25 18:49:41 -04:00
Sam Roberts
ea1b8a5cbc
doc: sort bottom-of-file markdown links
...
PR-URL: https://github.com/nodejs/node/pull/12726
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com >
2017-05-08 09:30:55 -07:00
DavidCai
221b03ad20
events, doc: check input in defaultMaxListeners
...
PR-URL: https://github.com/nodejs/node/pull/11938
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com >
Reviewed-By: Brian White <mscdex@mscdex.net >
2017-03-22 13:59:45 -07:00
Amelia Clarke
38ba0c25d4
doc: missing argument types for events methods
...
Refs: https://github.com/nodejs/node/issues/9399
PR-URL: https://github.com/nodejs/node/pull/11802
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Brian White <mscdex@mscdex.net >
2017-03-14 17:15:35 -07:00
Vse Mozhet Byt
4d52d12fd1
doc: console.log() -> console.error() in events.md
...
PR-URL: https://github.com/nodejs/node/pull/11810
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Michaël Zasso <targos@protonmail.com >
Reviewed-By: Anna Henningsen <anna@addaleax.net >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2017-03-14 17:09:19 -07:00
Vse Mozhet Byt
e494e427c9
doc: var -> let / const in events.md
...
PR-URL: https://github.com/nodejs/node/pull/11810
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Michaël Zasso <targos@protonmail.com >
Reviewed-By: Anna Henningsen <anna@addaleax.net >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2017-03-14 17:09:13 -07:00
Roman Reiss
ff1361957d
doc: consistent case for primitive types
...
PR-URL: https://github.com/nodejs/node/pull/11167
Reviewed-By: Timothy Gu <timothygu99@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com >
2017-03-02 17:55:45 +01:00
Anna Henningsen
8fb16fdccd
doc: add changelogs for events
...
PR-URL: https://github.com/nodejs/node/pull/11489
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
Reviewed-By: Sam Roberts <vieuxtech@gmail.com >
Reviewed-By: Roman Reiss <me@silverwind.io >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Italo A. Casas <me@italoacasas.com >
2017-02-24 02:06:31 +01:00
Daniel Bevenius
367065be4b
doc: make comment indentation consistent
...
Currently, some of the docs use different indentation for comments
in the code examples. This commit makes the indentation consistent
by putting the comments at the beginning of the line (really no
indentation that is).
PR-URL: https://github.com/nodejs/node/pull/9518
Reviewed-By: Teddy Katz <teddy.katz@gmail.com >
Reviewed-By: Roman Reiss <me@silverwind.io >
Reviewed-By: Michaël Zasso <targos@protonmail.com >
2016-11-16 07:52:57 +01:00
Timothy Gu
e1ddcb7219
doc: standardize rest parameters
...
PR-URL: https://github.com/nodejs/node/pull/8485
Reviewed-By: Anna Henningsen <anna@addaleax.net >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2016-09-14 08:08:28 +02:00
Anna Henningsen
983775d457
events: make memory leak warning name more verbose
...
Switch from a generic `Warning` to the more specific
`MaxListenersExceededWarning`.
Ref: https://github.com/nodejs/node/pull/8298
PR-URL: https://github.com/nodejs/node/pull/8341
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Evan Lucas <evanlucas@me.com >
2016-09-04 17:11:59 +02:00
Anna Henningsen
932c824c60
events: make memory leak warning more accessible
...
This makes the famous `EventEmitter memory leak` warnings occurring
when the listener count for a given event exceeds a specified number
more programatically accessible, by giving them properties referring
to the event emitter instance and the event itself.
This can be useful for debugging the origins of such a warning when
the stack itself doesn’t reveal enough information about the event
emitter instance itself, e.g. when manual inspection of the
already-registered listeners is expected to be useful.
PR-URL: https://github.com/nodejs/node/pull/8298
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Jeremiah Senkpiel <Fishrock123@rocketmail.com >
2016-08-30 17:02:51 +02:00
Luigi Pinca
769f63ccd8
doc: add added: information for events
...
PR-URL: https://github.com/nodejs/node/pull/7822
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Brian White <mscdex@mscdex.net >
2016-08-05 14:43:09 -07:00
Anna Henningsen
c809b88345
doc: use blockquotes for Stability: markers
...
Use blockquotes instead of code blocks for stability markers in
the docs. Doing that:
- Makes the makers appear correctly when viewed e.g. on github.
- Allows remark-lint rules like `no-undefined-references` to work
properly (https://github.com/nodejs/node/pull/7729 ).
PR-URL: https://github.com/nodejs/node/pull/7757
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com >
Reviewed-By: Michaël Zasso <mic.besace@gmail.com >
Reviewed-By: Roman Reiss <me@silverwind.io >
2016-08-04 22:43:34 +02:00
Sakthipriyan Vairamani
af4915894b
doc: general improvments to events documentation
...
PR-URL: https://github.com/nodejs/node/pull/7480
Reviewed-By: James M Snell <jasnell@gmail.com >
2016-07-20 10:11:19 +05:30
Greyson Parrelli
62a858c60f
doc: fix events typo
...
This commit removes an extraneous word.
PR-URL: https://github.com/nodejs/node/pull/7329
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Brian White <mscdex@mscdex.net >
2016-06-17 13:25:28 -04:00
yorkie
6e9a4abb03
doc,events: fix a link typo
...
PR-URL: https://github.com/nodejs/node/pull/6640
Reviewed-By: Alexander Makarenko <estliberitas@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Evan Lucas <evanlucas@me.com >
2016-05-10 06:40:12 -05:00
Robert Jefe Lindstaedt
9daf4a2937
doc: discourage use of util.inherits
...
util.inherits breaks the prototype chain. A fix does not seem
useful, since ES6 extends provides language level support for the
same functionality.
This commit starts fasing out mentions of the method.
Fixes: https://github.com/nodejs/node/issues/6512
Fixes: https://github.com/nodejs/node/issues/4179
PR-URL: https://github.com/nodejs/node/pull/6514
Reviewed-By: James Snell <jasnell@gmail.com >
Reviewed-By: Michaël Zasso <mic.besace@gmail.com >
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
2016-05-09 14:10:41 +02:00
Сковорода Никита Андреевич
c1f2df9782
doc: fix EventEmitter#eventNames() example
...
Replace myErr with myEE in one place.
Fix the expected output to have the actual formatting.
PR-URL: https://github.com/nodejs/node/pull/6417
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Brian White <mscdex@mscdex.net >
2016-04-29 23:22:07 -07:00
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
James M Snell
0e7d57af35
events: add prependListener() and prependOnceListener()
...
A handful of modules (including readable-streams) make
inappropriate use of the internal _events property. One
such use is to prepend an event listener to the front
of the array of listeners.
This adds EE.prototype.prependListener() and
EE.prototype.prependOnceListener() methods to add handlers
to the *front* of the listener array.
Doc update and test case is included.
Fixes: https://github.com/nodejs/node/issues/1817
PR-URL: https://github.com/nodejs/node/pull/6032
Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com >
Reviewed-By: Brian White <mscdex@mscdex.net >
2016-04-22 09:28:37 -07:00
Robert Jefe Lindstaedt
0800c0aa72
doc: git mv to .md
...
* doc: rename .markdown references in content
* doc: rename to .md in tools
* doc: rename to .md in CONTRIBUTING.md
PR-URL: https://github.com/nodejs/node/pull/4747
Reviewed-By: Myles Borins <myles.borins@gmail.com >
Reviewed-By: techjeffharris
Reviewed-By: Johan Bergström <bugs@bergstroem.nu >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Anna Henningsen <anna@addaleax.net >
2016-04-20 16:34:27 -07:00