Update JSDoc.

diff --git a/src/lib/bip32-key-derivation.ts b/src/lib/bip32-key-derivation.ts
index 3bff28a2a51ee84c98adf0eb656382fa9e22b732..f9014f95086dd677b9654ce3ae56d369d96b5405 100644 (file)
--- a/src/lib/bip32-key-derivation.ts
+++ b/src/lib/bip32-key-derivation.ts
@@ -15,7 +15,7 @@ type ExtendedKey = {
 *\r
 * @param {string} seed - Hexadecimal seed derived from mnemonic phrase\r
 * @param {number} index - Account number between 0 and 2^31-1\r
-* @returns Private child key for the account\r
+* @returns {Promise<string>} Private child key for the account\r
 */\r
 export async function nanoCKD (seed: string, index: number): Promise<string> {\r
        if (!Number.isSafeInteger(index) || index < 0 || index > 0x7fffffff) {\r

diff --git a/src/lib/bip39-mnemonic.ts b/src/lib/bip39-mnemonic.ts
index 4ae0b6d44826b0d9f5c6bbea1cc3c6907d5a0d60..cae009d8625ea64af8409657c832ea10bce69c41 100644 (file)
--- a/src/lib/bip39-mnemonic.ts
+++ b/src/lib/bip39-mnemonic.ts
@@ -75,7 +75,7 @@ export class Bip39Mnemonic {
         * used to generate the mnemonic phrase.\r
         *\r
         * @param {Entropy} entropy - Cryptographically strong pseudorandom data of length N bits\r
-        * @returns First N/32 bits of the hash as a hexadecimal string\r
+        * @returns {Promise<string>} First N/32 bits of the hash as a hexadecimal string\r
         */\r
        static async checksum (entropy: Entropy): Promise<string> {\r
                const hashBuffer = await subtle.digest('SHA-256', entropy.bytes)\r

diff --git a/src/lib/block.ts b/src/lib/block.ts
index 691ec1fef9650e574da28ff1728970eea6040efe..36dda5ab79af85a35a5343582a56e0894df2bcea 100644 (file)
--- a/src/lib/block.ts
+++ b/src/lib/block.ts
@@ -42,7 +42,7 @@ abstract class Block {
        /**
        * Converts the block to JSON format as expected by the `process` RPC.
        *
-       * @returns JSON representation of the block
+       * @returns {string} JSON representation of the block
        */
        json (): { [key: string]: string } {
                return {

diff --git a/src/lib/rolodex.ts b/src/lib/rolodex.ts
index b32fc1b9940dd4153b89705fd9c49312e97b6a5d..0587dd607d53adfdea970012606286d6593370fb 100644 (file)
--- a/src/lib/rolodex.ts
+++ b/src/lib/rolodex.ts
@@ -91,7 +91,7 @@ export class Rolodex {
        * @param {string} name - Alias to look up
        * @param {string} signature - Signature to use for verification
        * @param {...string} data - Signed data to verify
-       * @returns {boolean} True if the signature was used to sign the data, else false
+       * @returns {Promise<boolean>} True if the signature was used to sign the data, else false
        */
        async verify (name: string, signature: string, ...data: string[]): Promise<boolean> {
                const Tools = await import('./tools.js')

diff --git a/src/lib/rpc.ts b/src/lib/rpc.ts
index cf8826343e37b14acb1c03dcfc4dbb16945ff65a..0e28d59d8441bcf31cfd4b425ca637275a7473b5 100644 (file)
--- a/src/lib/rpc.ts
+++ b/src/lib/rpc.ts
@@ -22,7 +22,7 @@ export class Rpc {
         *
         * @param {string} action - Nano protocol RPC call to execute
         * @param {object} [data] - JSON to send to the node as defined by the action
-        * @returns JSON-formatted RPC results from the node
+        * @returns {Promise<any>} JSON-formatted RPC results from the node
         */
        async call (action: string, data?: { [key: string]: any }): Promise<any> {
                this.#validate(action)

diff --git a/src/lib/tools.ts b/src/lib/tools.ts
index 48cd6e61c7299ac606ae1f361ef23df7fff4b9a5..cff52bf217cc220cc9191bbf22b88c623dfb15a3 100644 (file)
--- a/src/lib/tools.ts
+++ b/src/lib/tools.ts
@@ -149,7 +149,7 @@ export async function sweep (rpc: Rpc | string | URL, wallet: Blake2bWallet | Bi
 * @param {string} key - Hexadecimal-formatted public key to use for verification
 * @param {string} signature - Hexadcimal-formatted signature
 * @param {...string} input - Data to be verified
-* @returns {boolean} True if the data was signed by the public key's matching private key
+* @returns {Promise<boolean>} True if the data was signed by the public key's matching private key
 */
 export async function verify (key: string, signature: string, ...input: string[]): Promise<boolean> {
        const data = hash(input)