doc: crypto.randomBytes does not block when async #14993
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
jasnell
approved these changes
Aug 23, 2017
bnoordhuis
approved these changes
Aug 23, 2017
doc/api/crypto.md
Outdated
| @@ -1717,7 +1717,8 @@ console.log( | |||
| `${buf.length} bytes of random data: ${buf.toString('hex')}`); | |||
| ``` | |||
|
|
|||
| The `crypto.randomBytes()` method will block until there is sufficient entropy. | |||
| The `crypto.randomBytes()` method will not generate bytes until there is | |||
There was a problem hiding this comment.
s/generate bytes/complete/?
bnoordhuis
approved these changes
Aug 23, 2017
mscdex
reviewed
Aug 23, 2017
| @@ -1717,7 +1717,8 @@ console.log( | |||
| `${buf.length} bytes of random data: ${buf.toString('hex')}`); | |||
| ``` | |||
|
|
|||
| The `crypto.randomBytes()` method will block until there is sufficient entropy. | |||
| The `crypto.randomBytes()` method will not complete until there is | |||
There was a problem hiding this comment.
Isn't this only the case for the async version of this function (e.g. when a callback is passed)? How does it not block when the sync version is invoked and there is not sufficient entropy at that time? I think we should be explicit here about this difference.
There was a problem hiding this comment.
Its the case for both versions. If its sync, it won't complete. If it's async, it won't complete. Can you suggest some other wording? I think the current wording applies equally to both, and the previous wording applied only to the sync version.
lpinca
approved these changes
Aug 24, 2017
cjihrig
approved these changes
Aug 24, 2017
It may not return random bytes right away, but when called asynchronously it will not block. PR-URL: nodejs#14993 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
sam-github
force-pushed
the
crypto-does-not-block
branch
from
19a79ba
to
68321b5
Compare
ghost
pushed a commit
to ayojs/ayo
that referenced
this pull request
Aug 30, 2017
It may not return random bytes right away, but when called asynchronously it will not block. PR-URL: nodejs/node#14993 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
ghost
pushed a commit
to ayojs/ayo
that referenced
this pull request
Aug 30, 2017
It may not return random bytes right away, but when called asynchronously it will not block. PR-URL: nodejs/node#14993 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Sep 10, 2017
It may not return random bytes right away, but when called asynchronously it will not block. PR-URL: #14993 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Merged
MylesBorins
pushed a commit
that referenced
this pull request
Sep 12, 2017
It may not return random bytes right away, but when called asynchronously it will not block. PR-URL: #14993 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Sep 20, 2017
It may not return random bytes right away, but when called asynchronously it will not block. PR-URL: #14993 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Merged
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.
It may not return random bytes right away, but when called
asynchronously it will not block.
Checklist
Affected core subsystem(s)
doc