🤖 Merge PR DefinitelyTyped#72792 update 0.8.3 by @coldzonelin

Author: coldzonelin

types/js-md5/index.d.ts

@@ -1,29 +1,171 @@
 declare namespace md5 {
-    type message = string | any[] | Uint8Array | ArrayBuffer;
-
-    interface Md5 {
-        array(): number[];
-        arrayBuffer(): ArrayBuffer;
-        buffer(): ArrayBuffer;
-        digest(): number[];
-        hex(): string;
-        toString(): string;
-        update(message: message): Md5;
-        base64(): string;
-    }
-
-    interface md5 {
-        (message: message): string;
-        hex(message: message): string;
-        array(message: message): number[];
-        digest(message: message): number[];
-        arrayBuffer(message: message): ArrayBuffer;
-        buffer(message: message): ArrayBuffer;
-        create(): Md5;
-        update(message: message): Md5;
-        base64(message: message): string;
-    }
+  type Message = string | number[] | ArrayBuffer | Uint8Array;
+
+  interface Hasher {
+    /**
+     * Update hash
+     *
+     * @param message The message you want to hash.
+     */
+    update(message: Message): Hasher;
+
+    /**
+     * Return hash in hex string.
+     */
+    hex(): string;
+
+    /**
+     * Return hash in hex string.
+     */
+    toString(): string;
+
+    /**
+     * Return hash in ArrayBuffer.
+     */
+    arrayBuffer(): ArrayBuffer;
+
+    /**
+     * Return hash in integer array.
+     */
+    digest(): number[];
+
+    /**
+     * Return hash in integer array.
+     */
+    array(): number[];
+
+    /**
+     * Return hash in base64 string.
+     */
+    base64(): string;
+  }
+
+  interface Hmac {
+    /**
+     * Computes a Hash-based message authentication code (HMAC) using a secret key
+     *
+     * @param secretKey The Secret Key
+     * @param message The message you want to hash.
+     */
+    (secretKey: Message, message: Message): string;
+
+    /**
+     * Create a hash object using a secret key.
+     *
+     * @param secretKey The Secret Key
+     */
+    create(secretKey: Message): Hasher;
+
+    /**
+     * Create a hash object and hash message using a secret key
+     *
+     * @param secretKey The Secret Key
+     * @param message The message you want to hash.
+     */
+    update(secretKey: Message, message: Message): Hasher;
+
+    /**
+     * Return hash in hex string.
+     *
+     * @param secretKey The Secret Key
+     * @param message The message you want to hash.
+     */
+    hex(secretKey: Message, message: Message): string;
+
+    /**
+     * Return hash in ArrayBuffer.
+     *
+     * @param secretKey The Secret Key
+     * @param message The message you want to hash.
+     */
+    arrayBuffer(secretKey: Message, message: Message): ArrayBuffer;
+
+    /**
+     * Return hash in integer array.
+     *
+     * @param secretKey The Secret Key
+     * @param message The message you want to hash.
+     */
+    digest(secretKey: Message, message: Message): number[];
+
+    /**
+     * Return hash in integer array.
+     *
+     * @param secretKey The Secret Key
+     * @param message The message you want to hash.
+     */
+    array(secretKey: Message, message: Message): number[];
+
+    /**
+     * Return hash in base64 string.
+     *
+     * @param secretKey The Secret Key
+     * @param message The message you want to hash.
+     */
+    base64(secretKey: Message, message: Message): string;
+  }
+
+  interface Hash {
+    /**
+     * Hash and return hex string.
+     *
+     * @param message The message you want to hash.
+     */
+    (message: Message): string;
+
+    /**
+     * Create a hash object.
+     */
+    create(): Hasher;
+
+    /**
+     * Create a hash object and hash message.
+     *
+     * @param message The message you want to hash.
+     */
+    update(message: Message): Hasher;
+
+    /**
+     * Return hash in hex string.
+     *
+     * @param message The message you want to hash.
+     */
+    hex(message: Message): string;
+
+    /**
+     * Return hash in ArrayBuffer.
+     *
+     * @param message The message you want to hash.
+     */
+    arrayBuffer(message: Message): ArrayBuffer;
+
+    /**
+     * Return hash in integer array.
+     *
+     * @param message The message you want to hash.
+     */
+    digest(message: Message): number[];
+
+    /**
+     * Return hash in integer array.
+     *
+     * @param message The message you want to hash.
+     */
+    array(message: Message): number[];
+
+    /**
+     * Return hash in base64 string.
+     *
+     * @param message The message you want to hash.
+     */
+    base64(message: Message): string;
+
+    /**
+     * HMAC interface
+     */
+    hmac: Hmac;
+  }
 }
 
-declare const md5: md5.md5;
+declare const md5: md5.Hash;
 export = md5;

types/js-md5/js-md5-tests.ts

@@ -5,12 +5,11 @@ str = md5("The quick brown fox jumps over the lazy dog");
 let arr: number[] = md5.digest("The quick brown fox jumps over the lazy dog");
 arr = md5.array("The quick brown fox jumps over the lazy dog");
 let buf: ArrayBuffer = md5.arrayBuffer("The quick brown fox jumps over the lazy dog");
-buf = md5.buffer("The quick brown fox jumps over the lazy dog");
 md5.base64("The quick brown fox jumps over the lazy dog");
 
-// $ExpectType Md5
+// $ExpectType Hasher
 const hash1 = md5.create();
-// $ExpectType Md5
+// $ExpectType Hasher
 hash1.update("The quick brown fox jumps over the lazy dog");
 // $ExpectType string
 str = hash1.hex();
@@ -22,10 +21,9 @@ arr = hash1.digest();
 arr = hash1.array();
 // $ExpectType ArrayBuffer
 buf = hash1.arrayBuffer();
-// $ExpectType ArrayBuffer
-buf = hash1.buffer();
 
-// $ExpectType Md5
+
+// $ExpectType Hasher
 const hash2 = md5.update("The quick brown fox jumps over the lazy dog");
 // $ExpectType string
 str = hash2.hex();
@@ -37,8 +35,7 @@ arr = hash2.digest();
 arr = hash2.array();
 // $ExpectType ArrayBuffer
 buf = hash2.arrayBuffer();
-// $ExpectType ArrayBuffer
-buf = hash2.buffer();
+
 
 // $ExpectType string
 str = md5([]);

types/js-md5/package.json

@@ -1,7 +1,7 @@
 {
     "private": true,
     "name": "@types/js-md5",
-    "version": "0.7.9999",
+    "version": "0.8.9999",
     "projects": [
         "https://github.com/emn178/js-md5"
     ],