Skip to content

stream: enable autoDestroy by default #30623

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
ronag wants to merge 8 commits into from
Closed

stream: enable autoDestroy by default #30623

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
df2d395
stream: enable autoDestroy by default
ronag Nov 24, 2019
3e188d7
fixup: linting
ronag Nov 24, 2019
d9ff59b
fixup: tests
ronag Nov 24, 2019
28cf38d
fixup: test
ronag Nov 24, 2019
1899ada
fixup: docs
ronag Nov 24, 2019
616c56e
fixup: tests + Readable capture
ronag Dec 25, 2019
ccdfafe
Apply suggestions from code review
ronag Jan 1, 2020
1bb3889
fixup
ronag Jan 1, 2020
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
fixup: docs
  • Loading branch information
@ronag
ronag committed Jan 1, 2020
commit 1899ada4e34d48f5a22b303873f883d9cc8a76be
20 changes: 11 additions & 9 deletions doc/api/stream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,8 +277,8 @@ added: v0.9.4
The `'error'` event is emitted if an error occurred while writing or piping
data. The listener callback is passed a single `Error` argument when called.

The stream is not closed when the `'error'` event is emitted unless the
[`autoDestroy`][writable-new] option was set to `true` when creating the
The stream is closed when the `'error'` event is emitted unless the
[`autoDestroy`][writable-new] option was set to `false` when creating the
stream.

After `'error'`, no further events other than `'close'` *should* be emitted
Expand Down Expand Up @@ -1664,11 +1664,7 @@ const { Writable } = require('stream');

class MyWritable extends Writable {
constructor({ highWaterMark, ...options }) {
super({
highWaterMark,
autoDestroy: true,
emitClose: true
});
super({ highWaterMark });
// ...
}
}
Expand Down Expand Up @@ -1742,6 +1738,9 @@ changes:
pr-url: https://github.com/nodejs/node/pull/22795
description: Add `autoDestroy` option to automatically `destroy()` the
stream when it emits `'finish'` or errors.
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/30623
description: Change `autoDestroy` option default to `true`.
-->

* `options` {Object}
Expand Down Expand Up @@ -1773,7 +1772,7 @@ changes:
* `final` {Function} Implementation for the
[`stream._final()`][stream-_final] method.
* `autoDestroy` {boolean} Whether this stream should automatically call
`.destroy()` on itself after ending. **Default:** `false`.
`.destroy()` on itself after ending. **Default:** `true`.

<!-- eslint-disable no-useless-constructor -->
```js
Expand Down Expand Up @@ -2018,6 +2017,9 @@ changes:
pr-url: https://github.com/nodejs/node/pull/22795
description: Add `autoDestroy` option to automatically `destroy()` the
stream when it emits `'end'` or errors.
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/30623
description: Change `autoDestroy` option default to `true`.
-->

* `options` {Object}
Expand All @@ -2036,7 +2038,7 @@ changes:
* `destroy` {Function} Implementation for the
[`stream._destroy()`][readable-_destroy] method.
* `autoDestroy` {boolean} Whether this stream should automatically call
`.destroy()` on itself after ending. **Default:** `false`.
`.destroy()` on itself after ending. **Default:** `true`.

<!-- eslint-disable no-useless-constructor -->
```js
Expand Down