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

chore: provided JSDoc for deployToSASjs

This commit is contained in:
Saad Jutt
2022-02-11 21:18:18 +05:00
parent f48089cb8c
commit ebd55c5b02
2 changed files with 17 additions and 11 deletions

View File

@@ -5,9 +5,8 @@ import {
EditContextInput, EditContextInput,
PollOptions, PollOptions,
LoginMechanism, LoginMechanism,
FolderMember, ExecutionQuery,
ServiceMember, FileTree
ExecutionQuery
} from './types' } from './types'
import { SASViyaApiClient } from './SASViyaApiClient' import { SASViyaApiClient } from './SASViyaApiClient'
import { SAS9ApiClient } from './SAS9ApiClient' import { SAS9ApiClient } from './SAS9ApiClient'
@@ -865,15 +864,22 @@ export default class SASjs {
) )
} }
/**
* Creates the folders and services at the given location `appLoc` on the given server `serverUrl`.
* @param members - the JSON specifying the folders and services to be created.
* @param appLoc - the base folder in which to create the new folders and
* services. If not provided, is taken from SASjsConfig.
* @param authConfig - a valid client, secret, refresh and access tokens that are authorised to execute compute jobs.
*/
public async deployToSASjs( public async deployToSASjs(
members: [FolderMember, ServiceMember], members: FileTree,
appLoc?: string,
authConfig?: AuthConfig authConfig?: AuthConfig
) { ) {
return await this.sasJSApiClient?.deploy( if (!appLoc) {
members, appLoc = this.sasjsConfig.appLoc
this.sasjsConfig.appLoc, }
authConfig return await this.sasJSApiClient?.deploy(members, appLoc, authConfig)
)
} }
public async executeJobSASjs(query: ExecutionQuery) { public async executeJobSASjs(query: ExecutionQuery) {

View File

@@ -1,5 +1,5 @@
import { AuthConfig, ServerType } from '@sasjs/utils/types' import { AuthConfig, ServerType } from '@sasjs/utils/types'
import { FolderMember, ServiceMember, ExecutionQuery } from './types' import { FileTree, ExecutionQuery } from './types'
import { RequestClient } from './request/RequestClient' import { RequestClient } from './request/RequestClient'
import { getAccessTokenForSasjs } from './auth/getAccessTokenForSasjs' import { getAccessTokenForSasjs } from './auth/getAccessTokenForSasjs'
import { refreshTokensForSasjs } from './auth/refreshTokensForSasjs' import { refreshTokensForSasjs } from './auth/refreshTokensForSasjs'
@@ -17,7 +17,7 @@ export class SASjsApiClient {
} }
public async deploy( public async deploy(
members: [FolderMember, ServiceMember], members: FileTree,
appLoc: string, appLoc: string,
authConfig?: AuthConfig authConfig?: AuthConfig
) { ) {