diff --git a/.gitignore b/.gitignore index 41db3ac..359ebc8 100644 --- a/.gitignore +++ b/.gitignore @@ -6,3 +6,5 @@ build /coverage .DS_Store + +/docs/* \ No newline at end of file diff --git a/docs/.nojekyll b/docs/.nojekyll deleted file mode 100644 index e2ac661..0000000 --- a/docs/.nojekyll +++ /dev/null @@ -1 +0,0 @@ -TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/docs/classes/SAS9ApiClient.SAS9ApiClient.html b/docs/classes/SAS9ApiClient.SAS9ApiClient.html index 1a2b601..9484041 100644 --- a/docs/classes/SAS9ApiClient.SAS9ApiClient.html +++ b/docs/classes/SAS9ApiClient.SAS9ApiClient.html @@ -22,7 +22,7 @@ +
  • Defined in SAS9ApiClient.ts:11
  • @@ -56,7 +56,7 @@
    Optional httpsAgentOptions: AgentOptions

    Returns SAS9ApiClient

    +
  • Defined in SAS9ApiClient.ts:14
  • Methods

    @@ -83,7 +83,7 @@

    Returns Promise<string>

    +
  • Defined in SAS9ApiClient.ts:46
  • +
  • Defined in SAS9ApiClient.ts:26
  • Returns void

    +
  • Defined in SAS9ApiClient.ts:36
  • Returns void

    +
  • Defined in SASViyaApiClient.ts:72
  • Methods

    @@ -135,7 +135,7 @@

    Returns void

    +
  • Defined in SASViyaApiClient.ts:64
  • Returns Promise<Context>

    +
  • Defined in SASViyaApiClient.ts:194
  • Returns Promise<File>

    +
  • Defined in SASViyaApiClient.ts:329
  • Returns Promise<Folder>

    +
  • Defined in SASViyaApiClient.ts:373
  • Returns Promise<{ etag: string; result: Job }>

    +
  • Defined in SASViyaApiClient.ts:456
  • Returns Promise<Context>

    +
  • Defined in SASViyaApiClient.ts:219
  • Returns Promise<Session>

    +
  • Defined in SASViyaApiClient.ts:155
  • Returns Promise<unknown>

    +
  • Defined in SASViyaApiClient.ts:573
  • Returns Promise<{ etag: string; result: Context }>

    +
  • Defined in SASViyaApiClient.ts:256
  • Returns Promise<undefined | Folder>

    +
  • Defined in SASViyaApiClient.ts:1053
  • Returns Promise<{ etag: string; result: Context }>

    +
  • Defined in SASViyaApiClient.ts:239
  • Returns Promise<any>

    +
  • Defined in SASViyaApiClient.ts:598
  • Returns Promise<{ log: any; result: any }>

    +
  • Defined in SASViyaApiClient.ts:699
  • Returns Promise<any>

    +
  • Defined in SASViyaApiClient.ts:277
  • Returns Promise<SasAuthResponse>

    +
  • Defined in SASViyaApiClient.ts:536
  • Returns Promise<null | string>

    +
  • Defined in SASViyaApiClient.ts:493
  • Returns Promise<ContextAllAttributes>

    +
  • Defined in SASViyaApiClient.ts:938
  • Returns Promise<Context>

    +
  • Defined in SASViyaApiClient.ts:923
  • Returns Promise<{ attributes: {}; createdBy: any; id: any; name: any; version: any }[]>

    +
  • Defined in SASViyaApiClient.ts:118
  • +
  • Defined in SASViyaApiClient.ts:97
  • +
  • Defined in SASViyaApiClient.ts:125
  • Returns Promise<any[]>

    +
  • Defined in SASViyaApiClient.ts:141
  • Returns Promise<unknown>

    +
  • Defined in SASViyaApiClient.ts:313
  • Returns Promise<undefined | Job[]>

    +
  • Defined in SASViyaApiClient.ts:82
  • Returns Promise<{ attributes: {}; createdBy: any; id: any; name: any; version: any }[]>

    +
  • Defined in SASViyaApiClient.ts:133
  • Returns Promise<any[]>

    +
  • Defined in SASViyaApiClient.ts:953
  • Returns Promise<undefined | Folder>

    +
  • Defined in SASViyaApiClient.ts:982
  • Returns Promise<SasAuthResponse>

    +
  • Defined in SASViyaApiClient.ts:555
  • Returns void

    +
  • Defined in SASViyaApiClient.ts:109
  • Returns Promise<{ isLoggedIn: boolean; loginForm?: any; userName: string }>

    +
  • Defined in SASjs.ts:579
  • +
  • Defined in SASjs.ts:956
  • Returns Promise<Context>

    +
  • Defined in SASjs.ts:200
  • Returns Promise<File>

    +
  • Defined in SASjs.ts:357
  • Returns Promise<Folder>

    +
  • Defined in SASjs.ts:324
  • Returns Promise<{ etag: string; result: Job }>

    +
  • Defined in SASjs.ts:445
  • Returns Promise<Context>

    +
  • Defined in SASjs.ts:227
  • Returns Promise<Session>

    +
  • Defined in SASjs.ts:309
  • Returns Promise<unknown>

    +
  • Defined in SASjs.ts:530
  • Returns Promise<{ etag: string; result: Context }>

    +
  • Defined in SASjs.ts:268
  • Returns Promise<undefined | Folder>

    +
  • Defined in SASjs.ts:397
  • Returns Promise<void>

    +
  • Defined in SASjs.ts:768
  • Returns Promise<undefined | { example?: {}; message: string; status: string; streamServiceName?: string }>

    +
  • Defined in SASjs.ts:837
  • Returns Promise<{ etag: string; result: Context }>

    +
  • Defined in SASjs.ts:249
  • -

    Returns Promise<undefined | { _webout?: string; error?: {}; log?: string; logPath?: string; message: string; status: string }>

    +
  • Defined in SASjs.ts:848
  • Returns Promise<undefined | string>

    +
  • Defined in SASjs.ts:88
  • Returns Promise<any>

    +
  • Defined in SASjs.ts:125
  • Returns Promise<undefined | string>

    +
  • Defined in SASjs.ts:107
  • Returns Promise<string>

    +
  • Defined in SASjs.ts:922
  • Returns Promise<SasAuthResponse | SASjsAuthResponse>

    +
  • Defined in SASjs.ts:484
  • Returns Promise<null | string>

    +
  • Defined in SASjs.ts:472
  • Returns Promise<ContextAllAttributes>

    +
  • Defined in SASjs.ts:300
  • Returns Promise<Context>

    +
  • Defined in SASjs.ts:283
  • Returns Promise<{ attributes: {}; createdBy: any; id: any; name: any; version: any }[]>

    +
  • Defined in SASjs.ts:156
  • Returns undefined | CsrfToken

    +
  • Defined in SASjs.ts:77
  • +
  • Defined in SASjs.ts:175
  • Returns Promise<any[]>

    +
  • Defined in SASjs.ts:185
  • Returns Promise<unknown>

    +
  • Defined in SASjs.ts:387
  • Returns Promise<{ attributes: {}; createdBy: any; id: any; name: any; version: any }[]>

    +
  • Defined in SASjs.ts:166
  • +
  • Defined in SASjs.ts:950
  • +
  • Defined in SASjs.ts:540
  • +
  • Defined in SASjs.ts:548
  • Returns Promise<undefined | any[]>

    +
  • Defined in SASjs.ts:408
  • Returns Promise<LoginResult>

    +
  • Defined in SASjs.ts:589
  • +
  • Defined in SASjs.ts:616
  • Returns Promise<undefined | Folder>

    +
  • Defined in SASjs.ts:429
  • Returns Promise<SasAuthResponse | SASjsAuthResponse>

    +
  • Defined in SASjs.ts:510
  • Returns Promise<any>

    +
  • Defined in SASjs.ts:682
  • Returns void

    +
  • Defined in SASjs.ts:568
  • Returns Promise<void>

    +
  • Defined in SASjs.ts:556
  • Returns Promise<any>

    +
  • Defined in SASjs.ts:874
  • Returns Promise<unknown>

    +
  • Defined in SASjs.ts:634
  • Returns Promise<{ example?: {}; message: string; status: string; streamServiceName?: string }>

    +
  • Defined in SASjsApiClient.ts:11
  • -

    Returns Promise<{ _webout?: string; error?: {}; log?: string; logPath?: string; message: string; status: string }>

    +
  • Defined in SASjsApiClient.ts:44
  • Returns Promise<string>

    +
  • Defined in SASjsApiClient.ts:71
  • Returns Promise<SASjsAuthResponse>

    +
  • Defined in SASjsApiClient.ts:101
  • Returns Promise<SASjsAuthResponse>

    +
  • Defined in SASjsApiClient.ts:112
  • +
  • Defined in types/SASjsConfig.ts:52
  • debug: boolean = true

    Set to true to enable additional debugging.

    +
  • Defined in types/SASjsConfig.ts:47
  • httpsAgentOptions?: AgentOptions
    @@ -94,14 +94,14 @@ By providing key, cert, ca to connect wit Other options can be set rejectUnauthorized and requestCert

    +
  • Defined in types/SASjsConfig.ts:67
  • loginMechanism: LoginMechanism = LoginMechanism.Default

    Supported login mechanisms are - Redirected and Default

    +
  • Defined in types/SASjsConfig.ts:71
  • pathSAS9: string = ''
    @@ -109,7 +109,7 @@ Other options can be set rejectUnauthorized and requestCert
    +
  • Defined in types/SASjsConfig.ts:24
  • pathSASJS: string = ''
    @@ -117,7 +117,7 @@ will use '/SASStoredProcess/do' on SAS 9.

    will use '/SASjsApi/stp/execute' on SAS JS.

    +
  • Defined in types/SASjsConfig.ts:19
  • pathSASViya: string = ''
    @@ -125,7 +125,7 @@ will use '/SASjsApi/stp/execute' on SAS JS.

    will use '/SASJobExecution' on SAS Viya.

    +
  • Defined in types/SASjsConfig.ts:29
  • requestHistoryLimit?: number = 10
    @@ -133,14 +133,14 @@ will use '/SASJobExecution' on SAS Viya.

    may affect browser performance, especially with debug (logs) enabled.

    +
  • Defined in types/SASjsConfig.ts:76
  • serverType: null | ServerType = null

    Can be SAS9 or SASVIYA.

    +
  • Defined in types/SASjsConfig.ts:43
  • serverUrl: string = ''
    @@ -149,7 +149,7 @@ Can be omitted, eg if serving directly from the SAS Web Server or being streamed.

    +
  • Defined in types/SASjsConfig.ts:14
  • useComputeApi: null | boolean = null
    @@ -161,7 +161,7 @@ under the identity in the JES context. If useComputeApi is n triggered using the APIs instead of the Job Execution Web Service broker.

    +
  • Defined in types/SASjsConfig.ts:61
  • +
  • Defined in types/SASjsConfig.ts:81
  • +
  • Defined in types/Context.ts:29
  • id: string
    +
  • Defined in types/Context.ts:36
  • launchContext: { contextName: string }
    @@ -87,32 +87,32 @@
  • contextName: string
  • +
  • Defined in types/Context.ts:32
  • launchType: string
    +
  • Defined in types/Context.ts:28
  • modifiedBy: string
    +
  • Defined in types/Context.ts:35
  • modifiedTimeStamp: string
    +
  • Defined in types/Context.ts:25
  • name: string
    +
  • Defined in types/Context.ts:38
  • version: number
    +
  • Defined in types/Context.ts:37
  • +
  • Defined in types/Context.ts:12
  • name?: string
    +
  • Defined in types/Context.ts:10
  • +
  • Defined in types/Session.ts:5
  • +
  • Defined in types/WriteStream.ts:2
  • +
  • Defined in SASViyaApiClient.ts:1
  • diff --git a/docs/modules/SASjs.html b/docs/modules/SASjs.html index baeca87..e148dae 100644 --- a/docs/modules/SASjs.html +++ b/docs/modules/SASjs.html @@ -14,7 +14,7 @@
  • SASjs
  • Module SASjs

    +
  • Defined in SASjs.ts:1
  • diff --git a/docs/modules/SASjsApiClient.html b/docs/modules/SASjsApiClient.html index e65a084..8eb10ef 100644 --- a/docs/modules/SASjsApiClient.html +++ b/docs/modules/SASjsApiClient.html @@ -14,7 +14,7 @@
  • SASjsApiClient
  • Module SASjsApiClient

    +
  • Defined in SASjsApiClient.ts:1
  • diff --git a/docs/modules/types.html b/docs/modules/types.html index e89ed83..e07c13a 100644 --- a/docs/modules/types.html +++ b/docs/modules/types.html @@ -14,7 +14,7 @@
  • types
  • Module types

    +
  • Defined in types/index.ts:1