From 5ee57f3d0771f8ac525dc7151014d78863599f2a Mon Sep 17 00:00:00 2001
From: sabhas <sabirbk06@gmail.com>
Date: Fri, 3 Sep 2021 14:54:35 +0500
Subject: [PATCH] chore: added jsdoc header

---
 src/SASViyaApiClient.ts      |  6 ++++++
 src/SASjs.ts                 |  4 ++++
 src/request/RequestClient.ts | 13 +++++++++++++
 3 files changed, 23 insertions(+)

diff --git a/src/SASViyaApiClient.ts b/src/SASViyaApiClient.ts
index 5b64703..4cd6abe 100644
--- a/src/SASViyaApiClient.ts
+++ b/src/SASViyaApiClient.ts
@@ -51,6 +51,12 @@ export class SASViyaApiClient {
   )
   private folderMap = new Map<string, Job[]>()
 
+  /**
+   * A helper method used to call appendRequest method of RequestClient
+   * @param response - response from sasjs request
+   * @param program - name of program
+   * @param debug - a boolean that indicates whether debug was enabled or not
+   */
   public appendRequest(response: any, program: string, debug: boolean) {
     this.requestClient!.appendRequest(response, program, debug)
   }
diff --git a/src/SASjs.ts b/src/SASjs.ts
index 5249f7f..7be26d9 100644
--- a/src/SASjs.ts
+++ b/src/SASjs.ts
@@ -878,6 +878,10 @@ export default class SASjs {
     })
   }
 
+  /**
+   * this method returns an array of SASjsRequest
+   * @returns SASjsRequest[]
+   */
   public getSasRequests() {
     const requests = [...this.requestClient!.getRequests()]
     const sortedRequests = requests.sort(compareTimestamps)
diff --git a/src/request/RequestClient.ts b/src/request/RequestClient.ts
index fc7143c..6fbafe9 100644
--- a/src/request/RequestClient.ts
+++ b/src/request/RequestClient.ts
@@ -86,12 +86,25 @@ export class RequestClient implements HttpClient {
     return this.httpClient.defaults.baseURL || ''
   }
 
+  /**
+   * this method returns all requests, an array of SASjsRequest type
+   * @returns SASjsRequest[]
+   */
   public getRequests = () => this.requests
 
+  /**
+   * this method clears the requests array, i.e set to empty
+   */
   public clearRequests = () => {
     this.requests = []
   }
 
+  /**
+   * this method appends the response from sasjs request to requests array
+   * @param response - response from sasjs request
+   * @param program - name of program
+   * @param debug - a boolean that indicates whether debug was enabled or not
+   */
   public appendRequest(response: any, program: string, debug: boolean) {
     let sourceCode = ''
     let generatedCode = ''