diff options
author | Maximilian Krambach <[email protected]> | 2018-08-17 15:14:51 +0000 |
---|---|---|
committer | Maximilian Krambach <[email protected]> | 2018-08-17 15:14:51 +0000 |
commit | 3fb094a9b8c320fc10e537a9bb5fab34807f4e52 (patch) | |
tree | 214cba50c94267916f2cecc039fdeadabc63fb8b /lang/js/src/Key.js | |
parent | js: removed Key.armor property in synchronous use (diff) | |
download | gpgme-3fb094a9b8c320fc10e537a9bb5fab34807f4e52.tar.gz gpgme-3fb094a9b8c320fc10e537a9bb5fab34807f4e52.zip |
js: small documentation fix
--
Diffstat (limited to 'lang/js/src/Key.js')
-rw-r--r-- | lang/js/src/Key.js | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/lang/js/src/Key.js b/lang/js/src/Key.js index 5d0c8160..ea6fd883 100644 --- a/lang/js/src/Key.js +++ b/lang/js/src/Key.js @@ -179,12 +179,13 @@ class GPGME_Key { }; /** - * Find out if the Key includes a secret part. Note that this is a - * rather nonperformant operation. - * If you want this inforrmation about more than a few Keys, it may be - * advisable to run {@link Keyring.getKeys} instead. - * @returns {Promise<Boolean|GPGME_Error>} True if a secret/private Key - * is available in the gnupg Keyring + * Find out if the Key is part of a Key pair including public and + * private key(s). If you want this information about more than a few + * Keys in synchronous mode, it may be advisable to run + * {@link Keyring.getKeys} instead, as it performs faster in bulk + * querying this state. + * @returns {Promise<Boolean|GPGME_Error>} True if a private Key is + * available in the gnupg Keyring. * @async */ this.getGnupgSecretState = function (){ |