Skip to content

stream: add auto-destroy mode #22795

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.

Sign up for GitHub

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

Closed
mafintosh wants to merge 7 commits into from
+158 −12
Closed

stream: add auto-destroy mode #22795

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
ccc94a9
stream: add auto-destroy mode
mafintosh Aug 21, 2018
38077e6
inline duplex autodestroy logic
mafintosh Oct 26, 2018
294e10c
move errorOrDestroy to destroyImpl
mafintosh Oct 26, 2018
a6eb82e
test ordering of events
mafintosh Oct 26, 2018
c40028a
fix docs
mafintosh Oct 29, 2018
7eb4e64
add to changes: section
mafintosh Oct 29, 2018
713a808
TDB -> REPLACEME
mafintosh Oct 29, 2018
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
add to changes: section
  • Loading branch information
@mafintosh
mafintosh committed Oct 29, 2018
commit 7eb4e6409228cabaf45cbcb103e741fd95d82fd4
13 changes: 13 additions & 0 deletions doc/api/stream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1493,6 +1493,11 @@ changes:
pr-url: https://github.com/nodejs/node/pull/18438
description: >
Add `emitClose` option to specify if `'close'` is emitted on destroy
- version: TBD
Copy link
Copy Markdown
Member

@mcollina mcollina Oct 29, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is the value we put here TBD? I never remember.

Copy link
Copy Markdown
Member

@addaleax addaleax Oct 29, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

REPLACEME :)

Copy link
Copy Markdown
Member Author

@mafintosh mafintosh Oct 29, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah right! Thanks, will fix

pr-url: https://github.com/nodejs/node/pull/22795
description: >
Add `autoDestroy` option to automatically `destroy()` the stream
when it emits `'finish'` or errors
-->

* `options` {Object}
Expand Down Expand Up @@ -1758,6 +1763,14 @@ Custom `Readable` streams *must* call the `new stream.Readable([options])`
constructor and implement the `readable._read()` method.

#### new stream.Readable([options])
<!-- YAML
changes:
- version: TBD
pr-url: https://github.com/nodejs/node/pull/22795
description: >
Add `autoDestroy` option to automatically `destroy()` the stream
when it emits `'end'` or errors
-->

* `options` {Object}
* `highWaterMark` {number} The maximum [number of bytes][hwm-gotcha] to store
Expand Down