doc: Setting the encoding to hex before piping the hash #35338
Merged
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
crypto
addaleax
approved these changes
Sep 25, 2020
doc/api/crypto.md
Outdated
Comment on lines
1033
to
1034
| hash.setEncoding('hex'); | ||
| input.pipe(hash).pipe(process.stdout); |
There was a problem hiding this comment.
This is completely optional, but maybe this way it becomes a bit more obvious where the hex encoding takes place?
Suggested change
| hash.setEncoding('hex'); | |
| input.pipe(hash).pipe(process.stdout); | |
| input.pipe(hash).setEncoding('hex').pipe(process.stdout); |
There was a problem hiding this comment.
Yep that would work, do you want me to submit another commit with your suggestion? Thank you!
There was a problem hiding this comment.
@vbarzana You can just add that commit to this PR, or use the “Commit suggestion” button here in the Github interface :)
There was a problem hiding this comment.
Done! Thank you, didn't see the button cause I was on the mobile 😉
gittysachin
approved these changes
Sep 25, 2020
tniessen
approved these changes
Sep 25, 2020
|
@tniessen good point :), my concern here's that the end user is human, and may be expecting to see a readable output. |
|
@vbarzana I completely agree, which is why I already approved your suggestion :) I just wanted to point out that it's not wrong per se. Thank you for your contribution! |
addaleax
added
the
author ready
vbarzana
changed the title
watilde
approved these changes
Sep 27, 2020
Trott
approved these changes
Sep 27, 2020
I found out that piping a hash to the stdout output would print a
non-hex set of characters, however, the examples are intended to print
out a hex-encoded output so, my proposal here is simple, we set the
encoding to `hex` before piping the response of the hash algo by calling
`hash.setEncoding('hex');`. With this the example is fixed
PR-URL: nodejs#35338
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
|
Landed in c15a227. Thanks for the contribution! 🎉 |
MylesBorins
pushed a commit
that referenced
this pull request
Sep 29, 2020
I found out that piping a hash to the stdout output would print a
non-hex set of characters, however, the examples are intended to print
out a hex-encoded output so, my proposal here is simple, we set the
encoding to `hex` before piping the response of the hash algo by calling
`hash.setEncoding('hex');`. With this the example is fixed
PR-URL: #35338
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Merged
joesepi
pushed a commit
to joesepi/node
that referenced
this pull request
Jan 8, 2021
I found out that piping a hash to the stdout output would print a
non-hex set of characters, however, the examples are intended to print
out a hex-encoded output so, my proposal here is simple, we set the
encoding to `hex` before piping the response of the hash algo by calling
`hash.setEncoding('hex');`. With this the example is fixed
PR-URL: nodejs#35338
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
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 found out that piping a hash to the stdout output would print a non-hex set of characters, however, the examples are intended to print out a hex-encoded output so, my proposal here is simple, we set the encoding to
hexbefore piping the response of the hash algo by callinghash.setEncoding('hex');. With this addition, the example is fixedMy 2 cents!
Thanks,
Victor
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes