doc: document that stream.on('close') was changed in Node 10 · nodejs/node@b67c4b4 · GitHub

nodejs / node Public

• Notifications You must be signed in to change notification settings
• Fork 36.6k
• Star 120k

• Code
• Issues 633
• Pull requests 755
• Actions
• Projects
• Security and quality
• Insights

Additional navigation options

Commit b67c4b4

Browse filesBrowse the repository at this point in the historyBrowse files

mcollina

authored and

addaleax

committed

doc: document that stream.on('close') was changed in Node 10

See: #25373 See: #18438 PR-URL: #25413 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Sam Roberts <vieuxtech@gmail.com>

1 parent d86a3e8 commit b67c4b4
Copy full SHA for b67c4b4

1 file changed

+14-2Lines changed: 14 additions & 2 deletions

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• doc/api
  • stream.md

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎doc/api/stream.md‎

Copy file name to clipboardExpand all lines: doc/api/stream.md

+14-2Lines changed: 14 additions & 2 deletions

• Display the source diff
• Display the rich diff

Original file line number	Diff line number	Diff line change
@@ -219,13 +219,19 @@ added: v0.9.4
219	219	##### Event: 'close'
220	220	<!-- YAML
221	221	added: v0.9.4
	222	+ changes:
	223	+ - version: v10.0.0
	224	+ pr-url: https://github.com/nodejs/node/pull/18438
	225	+ description: Add `emitClose` option to specify if `'close'` is emitted on
	226	+ destroy.
222	227	-->
223	228
224	229	The `'close'` event is emitted when the stream and any of its underlying
225	230	resources (a file descriptor, for example) have been closed. The event indicates
226	231	that no more events will be emitted, and no further computation will occur.
227	232
228		- Not all `Writable` streams will emit the `'close'` event.
	233	+ A [`Writable`][] stream will always emit the `'close'` event if it is
	234	+ created with the `emitClose` option.
229	235
230	236	##### Event: 'drain'
231	237	<!-- YAML
@@ -704,13 +710,19 @@ added: v0.9.4
704	710	##### Event: 'close'
705	711	<!-- YAML
706	712	added: v0.9.4
	713	+ changes:
	714	+ - version: v10.0.0
	715	+ pr-url: https://github.com/nodejs/node/pull/18438
	716	+ description: Add `emitClose` option to specify if `'close'` is emitted on
	717	+ destroy.
707	718	-->
708	719
709	720	The `'close'` event is emitted when the stream and any of its underlying
710	721	resources (a file descriptor, for example) have been closed. The event indicates
711	722	that no more events will be emitted, and no further computation will occur.
712	723
713		- Not all [`Readable`][] streams will emit the `'close'` event.
	724	+ A [`Readable`][] stream will always emit the `'close'` event if it is
	725	+ created with the `emitClose` option.
714	726
715	727	##### Event: 'data'
716	728	<!-- YAML

0 commit comments

Comments

0 (0)