Update docs and TS [skip ci]

openpgpjs · Aug 26, 2021 · 4b5aadb · 4b5aadb
1 parent ed594fe
commit 4b5aadb
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 6 deletions.
diff --git a/openpgp.d.ts b/openpgp.d.ts
@@ -359,7 +359,7 @@ declare abstract class BasePacket {
  * - A Subkey Packet cannot always be used when a Primary Key Packet is expected (and vice versa).
  */
 declare abstract class BasePublicKeyPacket extends BasePacket {
-  public algorithm: enums.publicKeyNames;
+  public algorithm: enums.publicKey;
   public created: Date;
   public version: number;
   public getAlgorithmInfo(): AlgorithmInfo;
@@ -417,8 +417,8 @@ export class SymEncryptedIntegrityProtectedDataPacket extends BasePacket {
 
 export class AEADEncryptedDataPacket extends BasePacket {
   static readonly tag: enums.packet.aeadEncryptedData;
-  private decrypt(sessionKeyAlgorithm: string, sessionKey: Uint8Array, config?: Config): void;
-  private encrypt(sessionKeyAlgorithm: string, sessionKey: Uint8Array, config?: Config): void;
+  private decrypt(sessionKeyAlgorithm: enums.symmetric, sessionKey: Uint8Array, config?: Config): void;
+  private encrypt(sessionKeyAlgorithm: enums.symmetric, sessionKey: Uint8Array, config?: Config): void;
   private crypt(fn: Function, sessionKey: Uint8Array, data: MaybeStream<Uint8Array>): MaybeStream<Uint8Array>
 }
 

diff --git a/src/crypto/public_key/elliptic/curves.js b/src/crypto/public_key/elliptic/curves.js
@@ -223,7 +223,7 @@ async function generate(curve) {
 /**
  * Get preferred hash algo to use with the given curve
  * @param {module:type/oid} oid - curve oid
- * @returns {module:enums.hash} hash algorithm
+ * @returns {enums.hash} hash algorithm
  */
 function getPreferredHashAlgo(oid) {
   return curves[enums.write(enums.curve, oid.toHex())].hash;

diff --git a/src/type/s2k.js b/src/type/s2k.js
@@ -38,9 +38,15 @@ class S2K {
    * @param {Object} [config] - Full configuration, defaults to openpgp.config
    */
   constructor(config = defaultConfig) {
-    /** @type {module:enums.hash} */
+    /**
+     * Hash function identifier, or 0 for gnu-dummy keys
+     * @type {module:enums.hash | 0}
+     */
     this.algorithm = enums.hash.sha256;
-    /** @type {module:enums.s2k} */
+    /**
+     * enums.s2k identifier or 'gnu-dummy'
+     * @type {String}
+     */
     this.type = 'iterated';
     /** @type {Integer} */
     this.c = config.s2kIterationCountByte;