stream,doc: require finished callback and add options docs #21058
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
BridgeAR
added
wip
Trott
previously requested changes
May 31, 2018
doc/api/stream.md
Outdated
| <!-- YAML | ||
| added: v10.0.0 | ||
| --> | ||
|
|
||
| * `stream` {Stream} A readable and/or writable stream. | ||
| * `options` {Object} | ||
| * `error` {boolean} If set to `false` a call to emit('error', err) is not |
There was a problem hiding this comment.
Comma after `false`, and maybe then as well:
If set to `false`, then a call to ...There was a problem hiding this comment.
Backticks around emit('error', err)
doc/api/stream.md
Outdated
| <!-- YAML | ||
| added: v10.0.0 | ||
| --> | ||
|
|
||
| * `stream` {Stream} A readable and/or writable stream. | ||
| * `options` {Object} | ||
| * `error` {boolean} If set to `false` a call to emit('error', err) is not | ||
| treated finished. **Default**: `true`. |
There was a problem hiding this comment.
Missing word or something. treated as finished perhaps?
doc/api/stream.md
Outdated
| * `options` {Object} | ||
| * `error` {boolean} If set to `false` a call to emit('error', err) is not | ||
| treated finished. **Default**: `true`. | ||
| * `readable` {boolean} When set to `false` the callback will be called after |
There was a problem hiding this comment.
Same thing with the comma and probably a then as well.
doc/api/stream.md
Outdated
| * `readable` {boolean} When set to `false` the callback will be called after | ||
| the stream ended but the stream might still be readable. **Default**: | ||
| `true`. | ||
| * `writable` {boolean} When set to `false` the callback will be called after |
There was a problem hiding this comment.
Same thing with the comma and probably a then as well.
doc/api/stream.md
Outdated
| * `error` {boolean} If set to `false` a call to emit('error', err) is not | ||
| treated finished. **Default**: `true`. | ||
| * `readable` {boolean} When set to `false` the callback will be called after | ||
| the stream ended but the stream might still be readable. **Default**: |
doc/api/stream.md
Outdated
| the stream ended but the stream might still be readable. **Default**: | ||
| `true`. | ||
| * `writable` {boolean} When set to `false` the callback will be called after | ||
| the stream ended but the stream might still be writable. **Default**: |
|
When we change a heading in the docs, we need to check if there are links to this heading in all the docs (copy the old hash from the old HTML doc and grep this hash in https://github.com/nodejs/node/blame/master/doc/api/stream.md#L2504 |
vsemozhetbyt
added
doc
|
LGTM on the changes mentioned from me |
Make the callback mandatory as mostly done in all other Node.js callback APIs so users explicitly have to decide what to do in error cases.
When originally implemented it was missed that Stream.finished() has an optional options object. This adds the docs to those.
BridgeAR
force-pushed
the
require-end-of-stream-callback
branch
from
27c3883
to
c310236
Compare
|
@Trott @nodejs/streams PTAL I addressed the comments and added some tests. |
|
Still LGTM, this can land. |
mcollina
added
the
author ready
|
@nodejs/tsc PTAL |
jasnell
approved these changes
Aug 21, 2018
|
@BridgeAR still lgtm |
BridgeAR
added a commit
to BridgeAR/node
that referenced
this pull request
Aug 21, 2018
Make the callback mandatory as mostly done in all other Node.js callback APIs so users explicitly have to decide what to do in error cases. This also documents the options for `Stream.finished()`. When originally implemented it was missed that Stream.finished() has an optional options object. PR-URL: nodejs#21058 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Mathias Buus <mathiasbuus@gmail.com>
|
Landed in 36468ca 🎉 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I just stumbled upon missing documentation about the
Stream.finished()options. We should also make the callback mandatory as already documented. Right now there would be a no op added in case a falsy value is provided for the callback.Test cases are missing and I'll add some later on (if someone wants to add them, I am also more than happy about that ;-) please feel free to just directly pushing on this branch).Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes