chore(ts): add documentation for Action.ts

Author: jescalada

src/proxy/actions/Action.ts

@@ -1,7 +1,9 @@
-/** Class representing a Push. */
 import { getProxyUrl } from "../../config";
 import { Step } from "./Step";
 
+/**
+ * Class representing a Push.
+ */
 class Action {
   steps: Step[] = [];
   error: boolean = false;
@@ -29,6 +31,14 @@ class Action {
   url: string;
   repo: string;
 
+  /**
+   * Create an action.
+   * @param {string} id The id of the action
+   * @param {string} type The type of the action
+   * @param {string} method The method of the action
+   * @param {number} timestamp The timestamp of the action
+   * @param {string} repo The repo of the action
+   */
   constructor(id: string, type: string, method: string, timestamp: number, repo: string) {
     this.id = id;
     this.type = type;
@@ -41,7 +51,7 @@ class Action {
   }
 
   /**
-   * Add a step to the action
+   * Add a step to the action.
    * @param {Step} step 
    */
   addStep(step: Step): void {
@@ -59,29 +69,53 @@ class Action {
     }
   }
 
+  /**
+   * Get the last step of the action.
+   * @return {Step} The last step of the action
+   */
   getLastStep(): Step | undefined {
     return this.lastStep;
   }
 
+  /**
+   * Set the commit range for the action.
+   * @param commitFrom the starting commit
+   * @param commitTo the ending commit
+   */
   setCommit(commitFrom: string, commitTo: string): void {
     this.commitFrom = commitFrom;
     this.commitTo = commitTo;
     this.id = `${commitFrom}__${commitTo}`;
   }
 
+  /**
+   * Set the branch for the action.
+   * @param branch the branch
+   */
   setBranch(branch: string): void {
     this.branch = branch;
   }
 
+  /**
+   * Set the message for the action.
+   * @param message the message
+   */
   setMessage(message: string): void {
     this.message = message;
   }
 
+  /**
+   * Allow the action to continue.
+   */
   setAllowPush(): void {
     this.allowPush = true;
     this.blocked = false;
   }
 
+  /**
+   * Check if the action can continue.
+   * @return {boolean} true if the action can continue, false otherwise
+   */
   continue(): boolean {
     return !(this.error || this.blocked);
   }