Docs: mark global generateSessionKeys
's encryptionKeys
as optional
#1596
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.
generateSessionKeys
callsMessage.generateSessionKeys
, which callshelper.js
'sgetPreferredAlgo
, which returnsconfig.preferredSymmetricAlgorithm
when theencryptionKeys
array is empty.encryptionKeys
also defaults to an empty array, andMessage.generateSessionkeys
'sencryptionKeys
is properly marked as optional, so this seems to just be an oversight from the doc.I'm not familiar with the code or jsdoc or if there's a particular doc style, so feel free to edit!
In any case, it looks like it renders correctly: