Commit 670f310
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 39d9a61 commit 670f310
1 file changed
+1
-1
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
3884 | 3884 | | |
3885 | 3885 | | |
3886 | 3886 | | |
3887 | | - | |
| 3887 | + | |
3888 | 3888 | | |
3889 | 3889 | | |
3890 | 3890 | | |
| |||
0 commit comments