1
0
mirror of https://github.com/sasjs/adapter.git synced 2026-01-18 09:30:06 +00:00

chore: added jsdoc header

This commit is contained in:
2021-09-03 14:54:35 +05:00
parent 146b0715bf
commit 5ee57f3d07
3 changed files with 23 additions and 0 deletions

View File

@@ -51,6 +51,12 @@ export class SASViyaApiClient {
) )
private folderMap = new Map<string, Job[]>() 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) { public appendRequest(response: any, program: string, debug: boolean) {
this.requestClient!.appendRequest(response, program, debug) this.requestClient!.appendRequest(response, program, debug)
} }

View File

@@ -878,6 +878,10 @@ export default class SASjs {
}) })
} }
/**
* this method returns an array of SASjsRequest
* @returns SASjsRequest[]
*/
public getSasRequests() { public getSasRequests() {
const requests = [...this.requestClient!.getRequests()] const requests = [...this.requestClient!.getRequests()]
const sortedRequests = requests.sort(compareTimestamps) const sortedRequests = requests.sort(compareTimestamps)

View File

@@ -86,12 +86,25 @@ export class RequestClient implements HttpClient {
return this.httpClient.defaults.baseURL || '' return this.httpClient.defaults.baseURL || ''
} }
/**
* this method returns all requests, an array of SASjsRequest type
* @returns SASjsRequest[]
*/
public getRequests = () => this.requests public getRequests = () => this.requests
/**
* this method clears the requests array, i.e set to empty
*/
public clearRequests = () => { public clearRequests = () => {
this.requests = [] 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) { public appendRequest(response: any, program: string, debug: boolean) {
let sourceCode = '' let sourceCode = ''
let generatedCode = '' let generatedCode = ''