Update update() docstring

Caligatio · Oct 9, 2022 · 2c60363 · 2c60363
1 parent 767e16f
commit 2c60363
Show file tree

Hide file tree

Showing 9 changed files with 11 additions and 4 deletions.
diff --git a/dist/sha.d.ts b/dist/sha.d.ts
@@ -78,7 +78,8 @@ declare class jsSHA {
     /**
      * Takes `input` and hashes as many blocks as possible. Stores the rest for either a future `update` or `getHash` call.
      *
-     * @param input The input to be hashed
+     * @param input The input to be hashed.
+     * @returns A reference to the object.
      */
     update(input: string | ArrayBuffer | Uint8Array): this;
     /**

diff --git a/dist/sha.js.map b/dist/sha.js.map
diff --git a/dist/sha.mjs.map b/dist/sha.mjs.map
diff --git a/dist/sha1.d.ts b/dist/sha1.d.ts
@@ -69,6 +69,7 @@ declare abstract class jsSHABase<StateT, VariantT> {
      * Hashes as many blocks as possible.  Stores the rest for either a future update or getHash call.
      *
      * @param srcString The input to be hashed.
+     * @returns A reference to the object.
      */
     update(srcString: string | ArrayBuffer | Uint8Array): this;
     /**

diff --git a/dist/sha256.d.ts b/dist/sha256.d.ts
@@ -69,6 +69,7 @@ declare abstract class jsSHABase<StateT, VariantT> {
      * Hashes as many blocks as possible.  Stores the rest for either a future update or getHash call.
      *
      * @param srcString The input to be hashed.
+     * @returns A reference to the object.
      */
     update(srcString: string | ArrayBuffer | Uint8Array): this;
     /**

diff --git a/dist/sha3.d.ts b/dist/sha3.d.ts
@@ -89,6 +89,7 @@ declare abstract class jsSHABase<StateT, VariantT> {
      * Hashes as many blocks as possible.  Stores the rest for either a future update or getHash call.
      *
      * @param srcString The input to be hashed.
+     * @returns A reference to the object.
      */
     update(srcString: string | ArrayBuffer | Uint8Array): this;
     /**

diff --git a/dist/sha512.d.ts b/dist/sha512.d.ts
@@ -69,6 +69,7 @@ declare abstract class jsSHABase<StateT, VariantT> {
      * Hashes as many blocks as possible.  Stores the rest for either a future update or getHash call.
      *
      * @param srcString The input to be hashed.
+     * @returns A reference to the object.
      */
     update(srcString: string | ArrayBuffer | Uint8Array): this;
     /**

diff --git a/src/common.ts b/src/common.ts
@@ -226,6 +226,7 @@ export abstract class jsSHABase<StateT, VariantT> {
    * Hashes as many blocks as possible.  Stores the rest for either a future update or getHash call.
    *
    * @param srcString The input to be hashed.
+   * @returns A reference to the object.
    */
   update(srcString: string | ArrayBuffer | Uint8Array): this {
     let i,

diff --git a/src/sha.ts b/src/sha.ts
@@ -87,7 +87,8 @@ export default class jsSHA {
   /**
    * Takes `input` and hashes as many blocks as possible. Stores the rest for either a future `update` or `getHash` call.
    *
-   * @param input The input to be hashed
+   * @param input The input to be hashed.
+   * @returns A reference to the object.
    */
   update(input: string | ArrayBuffer | Uint8Array): this {
     this.shaObj.update(input);