Skip to content

Commit

Permalink
Docs: mark global generateSessionKeys's encryptionKeys as optional (
Browse files Browse the repository at this point in the history
  • Loading branch information
LucienLeMagicien committed Feb 17, 2023
1 parent 71fef43 commit 3e6e8d0
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/openpgp.js
Original file line number Diff line number Diff line change
Expand Up @@ -507,9 +507,9 @@ export async function verify({ message, verificationKeys, expectSigned = false,
///////////////////////////////////////////////

/**
* Generate a new session key object, taking the algorithm preferences of the passed public keys into account.
* Generate a new session key object, taking the algorithm preferences of the passed public keys into account, if any.
* @param {Object} options
* @param {PublicKey|PublicKey[]} options.encryptionKeys - Array of public keys or single key used to select algorithm preferences for
* @param {PublicKey|PublicKey[]} [options.encryptionKeys] - Array of public keys or single key used to select algorithm preferences for. If no keys are given, the algorithm will be [config.preferredSymmetricAlgorithm]{@link module:config.preferredSymmetricAlgorithm}
* @param {Date} [options.date=current date] - Date to select algorithm preferences at
* @param {Object|Object[]} [options.encryptionUserIDs=primary user IDs] - User IDs to select algorithm preferences for
* @param {Object} [options.config] - Custom configuration settings to overwrite those in [config]{@link module:config}
Expand Down

0 comments on commit 3e6e8d0

Please sign in to comment.