doc: fix mistake in http2stream.respondWithFile. #15501
Closed
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
nodejs-github-bot
added
doc
jasnell
approved these changes
Sep 20, 2017
lpinca
approved these changes
Sep 21, 2017
doc/api/http2.md
Outdated
| @@ -1146,7 +1146,8 @@ of the given file: | |||
|
|
|||
| If an error occurs while attempting to read the file data, the `Http2Stream` | |||
| will be closed using an `RST_STREAM` frame using the standard `INTERNAL_ERROR` | |||
| code. | |||
| code. The onError callback will be called before send if is defined, otherwise | |||
There was a problem hiding this comment.
Nit: can you please add backticks (`) around onError?
There was a problem hiding this comment.
Of course, I will fix that and I rebase on master too.
hiroppy
approved these changes
Sep 21, 2017
antoine-amara
force-pushed
the
doc-#15390-update-responseWithFile
branch
from
3959dc9 to
705bbe2
Compare
|
Fix the onError syntax and rebase the branch on master. Thanks for the review. |
BridgeAR
reviewed
Sep 24, 2017
doc/api/http2.md
Outdated
| @@ -1147,7 +1147,8 @@ of the given file: | |||
|
|
|||
| If an error occurs while attempting to read the file data, the `Http2Stream` | |||
| will be closed using an `RST_STREAM` frame using the standard `INTERNAL_ERROR` | |||
| code. | |||
| code. The `onError` callback will be called before send if is defined, otherwise | |||
There was a problem hiding this comment.
The send if is defined sounds somewhat wrong to me. Can we change that to something like
If the `onError` callback is defined it will be called, otherwise the stream will be destroyed.?
antoine-amara
force-pushed
the
doc-#15390-update-responseWithFile
branch
from
705bbe2 to
2200309
Compare
http2stream.respondWithFile api has changed since 8.5.0 with the addition of the onError option. In the first code example an onError function is implemented but never used, fix this mistake. Add a description to have more informations when onError is triggered. Fixes: nodejs#15390
antoine-amara
force-pushed
the
doc-#15390-update-responseWithFile
branch
from
2200309 to
42c244d
Compare
BridgeAR
approved these changes
Sep 27, 2017
|
Landed in 51bc7fa |
BridgeAR
pushed a commit
that referenced
this pull request
Sep 27, 2017
http2stream.respondWithFile api has changed since 8.5.0 with the addition of the onError option. In the first code example an onError function is implemented but never used, fix this mistake. Add a description to have more informations when onError is triggered. PR-URL: #15501 Fixes: #15390 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: Ruben Bridgewater <ruben@bridgewater.de>
MylesBorins
pushed a commit
to MylesBorins/node
that referenced
this pull request
Sep 28, 2017
http2stream.respondWithFile api has changed since 8.5.0 with the addition of the onError option. In the first code example an onError function is implemented but never used, fix this mistake. Add a description to have more informations when onError is triggered. PR-URL: nodejs#15501 Fixes: nodejs#15390 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: Ruben Bridgewater <ruben@bridgewater.de>
MylesBorins
pushed a commit
that referenced
this pull request
Sep 29, 2017
http2stream.respondWithFile api has changed since 8.5.0 with the addition of the onError option. In the first code example an onError function is implemented but never used, fix this mistake. Add a description to have more informations when onError is triggered. PR-URL: #15501 Fixes: #15390 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: Ruben Bridgewater <ruben@bridgewater.de>
addaleax
pushed a commit
to addaleax/ayo
that referenced
this pull request
Sep 30, 2017
http2stream.respondWithFile api has changed since 8.5.0 with the addition of the onError option. In the first code example an onError function is implemented but never used, fix this mistake. Add a description to have more informations when onError is triggered. PR-URL: nodejs/node#15501 Fixes: nodejs/node#15390 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: Ruben Bridgewater <ruben@bridgewater.de>
MylesBorins
pushed a commit
that referenced
this pull request
Oct 3, 2017
http2stream.respondWithFile api has changed since 8.5.0 with the addition of the onError option. In the first code example an onError function is implemented but never used, fix this mistake. Add a description to have more informations when onError is triggered. PR-URL: #15501 Fixes: #15390 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: Ruben Bridgewater <ruben@bridgewater.de>
Merged
MylesBorins
pushed a commit
that referenced
this pull request
Oct 3, 2017
http2stream.respondWithFile api has changed since 8.5.0 with the addition of the onError option. In the first code example an onError function is implemented but never used, fix this mistake. Add a description to have more informations when onError is triggered. PR-URL: #15501 Fixes: #15390 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: Ruben Bridgewater <ruben@bridgewater.de>
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.
http2stream.respondWithFile api has changed since 8.5.0 with the
addition of the onError option. In the first code example an
onError function is implemented but never used, fix this
mistake.
Add a description more informations when onError is triggered.
Fixes: #15390
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passesAffected core subsystem(s)