Updating JSDocs

src/coinbase/faucet_transaction.ts

@@ -10,7 +10,8 @@ export class FaucetTransaction {
   /**
    * Creates a new FaucetTransaction instance.
    * Do not use this method directly - instead, use Address.faucet().
-   * @param model - The FaucetTransaction model.
+   * @constructor
+   * @param {FaucetTransactionModel} model - The FaucetTransaction model.
    * @throws {InternalError} If the model does not exist.
    */
   constructor(model: FaucetTransactionModel) {
@@ -22,15 +23,15 @@ export class FaucetTransaction {
 
   /**
    * Returns the transaction hash.
-   * @returns The onchain transaction hash as a string.
+   * @returns {string} The transaction hash.
    */
   public getTransactionHash(): string {
     return this.model.transaction_hash;
   }
 
   /**
    * Returns the link to the transaction on the blockchain explorer.
-   * @returns The link to the transaction on the blockchain explorer
+   * @returns {string} The link to the transaction on the blockchain explorer
    */
   public getTransactionLink(): string {
     // TODO: Parameterize this by Network.
@@ -39,7 +40,7 @@ export class FaucetTransaction {
 
   /**
    * Returns a string representation of the FaucetTransaction.
-   * @returns A string representation of the FaucetTransaction.
+   * @returns {string} A string representation of the FaucetTransaction.
    */
   public toString(): string {
     return `Coinbase::FaucetTransaction{transaction_hash: '${this.getTransactionHash()}', transaction_link: '${this.getTransactionLink()}'}`;