doc: mark the callback argument of crypto.generatePrime as mandatory · nodejs/node@f04f09d · GitHub

nodejs / node Public

• Notifications You must be signed in to change notification settings
• Fork 36.6k
• Star 120k

• Code
• Issues 637
• Pull requests 759
• Actions
• Projects
• Security and quality
• Insights

Additional navigation options

Commit f04f09d

Browse filesBrowse the repository at this point in the historyBrowse files

mureinik

authored and

targos

committed

doc: mark the callback argument of crypto.generatePrime as mandatory

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: #58298 PR-URL: #58299 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com> Reviewed-By: Edy Silva <edigleyssonsilva@gmail.com>

1 parent 3b9b010 commit f04f09d
Copy full SHA for f04f09d

1 file changed

+1-1Lines changed: 1 addition & 1 deletion

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• doc/api
  • crypto.md

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎doc/api/crypto.md‎

Copy file name to clipboardExpand all lines: doc/api/crypto.md

+1-1Lines changed: 1 addition & 1 deletion

• Display the source diff
• Display the rich diff

Original file line number	Diff line number	Diff line change
@@ -3900,7 +3900,7 @@ console.log(key.export().toString('hex')); // e89..........41e
3900	3900	The size of a generated HMAC key should not exceed the block size of the
3901	3901	underlying hash function. See [`crypto.createHmac()`][] for more information.
3902	3902
3903		- ### `crypto.generatePrime(size[, options[, callback]])`
	3903	+ ### `crypto.generatePrime(size[, options], callback)`
3904	3904
3905	3905	<!-- YAML
3906	3906	added: v15.8.0

0 commit comments

Comments

0 (0)