doc: mark the callback argument of crypto.generatePrime as mandatory #58299
+1
−1
Conversation
This file contains hidden or 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
|
Review requested:
|
nodejs-github-bot
added
crypto
mureinik
force-pushed
the
generatePrime-doc
branch
from
729d702 to
51cc18d
Compare
mureinik
changed the title
mureinik
force-pushed
the
generatePrime-doc
branch
from
51cc18d to
44a7fd0
Compare
mureinik
changed the title
The current documentation lists the `callback` argument of `crypto.generatePrime` as optional (it's surrounded by square brackets), but this is incorrect - calling the function without a callback will result in an `ERR_INVALID_ARG_TYPE` error: For the record, the correct way to generate a prime synchronously, without a callback, is to use the `generatePrimeSync` API. This patch fixes the documentation and marks the callback argument as mandatory. The `options` (second) argument, is indeed optional, and is marked as such. Fixes: nodejs#58298
mureinik
force-pushed
the
generatePrime-doc
branch
from
44a7fd0 to
4cf5fc2
Compare
jasnell
approved these changes
May 12, 2025
UlisesGascon
approved these changes
May 13, 2025
panva
added
commit-queue
geeksilva97
approved these changes
May 13, 2025
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.
The current documentation lists the
callbackargument ofcrypto.generatePrimeas optional (it's surrounded by square brackets), but this is incorrect - calling the function without a callback will result in an error:For the record, the correct way to generate a prime synchronously, without a callback, is to use the
generatePrimeSyncAPI.This PR fixes the documentation and marks the callback argument as mandatory. The
options(second) argument, is indeed optional, and is marked as such.Fixes: #58298