From 182de51f9be98fcf44d37284312ed07032501f3d Mon Sep 17 00:00:00 2001
From: Saad Jutt <ihsan.distranger@gmail.com>
Date: Sun, 5 Dec 2021 19:27:07 +0500
Subject: [PATCH] chore: added comments

---
 src/SASjs.ts                        | 2 ++
 src/auth/AuthManager.ts             | 3 +++
 src/job-execution/WebJobExecutor.ts | 1 +
 3 files changed, 6 insertions(+)

diff --git a/src/SASjs.ts b/src/SASjs.ts
index 76632e4..e6db53d 100644
--- a/src/SASjs.ts
+++ b/src/SASjs.ts
@@ -528,6 +528,7 @@ export default class SASjs {
 
   /**
    * Checks whether a session is active, or login is required.
+   * @param accessToken - an optional access token is required for SASjs server type.
    * @returns - a promise which resolves with an object containing two values - a boolean `isLoggedIn`, and a string `userName`.
    */
   public async checkSession(accessToken?: string) {
@@ -564,6 +565,7 @@ export default class SASjs {
 
   /**
    * Logs out of the configured SAS server.
+   * @param accessToken - an optional access token is required for SASjs server type.
    */
   public logOut(accessToken?: string) {
     return this.authManager!.logOut(accessToken)
diff --git a/src/auth/AuthManager.ts b/src/auth/AuthManager.ts
index 3c18088..a0bddcc 100644
--- a/src/auth/AuthManager.ts
+++ b/src/auth/AuthManager.ts
@@ -182,6 +182,7 @@ export class AuthManager {
 
   /**
    * Checks whether a session is active, or login is required.
+   * @param accessToken - an optional access token is required for SASjs server type.
    * @returns - a promise which resolves with an object containing three values
    *  - a boolean `isLoggedIn`
    *  - a string `userName` and
@@ -231,6 +232,7 @@ export class AuthManager {
         ? `${this.serverUrl}/SASStoredProcess`
         : `${this.serverUrl}/SASjsApi/session`
 
+    // Access token is required for server type `SASjs`
     const { result: loginResponse } = await this.requestClient
       .get<string>(url, accessToken, 'text/plain')
       .catch((err: any) => {
@@ -311,6 +313,7 @@ export class AuthManager {
 
   /**
    * Logs out of the configured SAS server.
+   * @param accessToken - an optional access token is required for SASjs server type.
    */
   public logOut(accessToken?: string) {
     if (this.serverType === ServerType.Sasjs) {
diff --git a/src/job-execution/WebJobExecutor.ts b/src/job-execution/WebJobExecutor.ts
index de6a23b..9f91ab3 100644
--- a/src/job-execution/WebJobExecutor.ts
+++ b/src/job-execution/WebJobExecutor.ts
@@ -144,6 +144,7 @@ export class WebJobExecutor extends BaseJobExecutor {
     }
 
     const requestPromise = new Promise((resolve, reject) => {
+      // Access token is required for server type `SASjs`
       this.requestClient!.post(apiUrl, formData, authConfig?.access_token)
         .then(async (res: any) => {
           const resObj =