1
0
mirror of https://github.com/sasjs/adapter.git synced 2025-12-10 17:04:36 +00:00

docs(pid): updated docs

This commit is contained in:
Yury Shkoda
2020-12-23 09:18:49 +03:00
parent 2e66bfde4b
commit aa7c3ae4a9
4 changed files with 62 additions and 41 deletions

View File

@@ -212,8 +212,8 @@
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L1449">
SASjs.ts:1449
<a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L1452">
SASjs.ts:1452
</a>
</li>
</ul>
@@ -748,8 +748,8 @@
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L1352">
SASjs.ts:1352
<a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L1355">
SASjs.ts:1355
</a>
</li>
</ul>
@@ -1047,8 +1047,8 @@
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L1444">
SASjs.ts:1444
<a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L1447">
SASjs.ts:1447
</a>
</li>
</ul>
@@ -1402,15 +1402,15 @@
<a name="startcomputejob" class="tsd-anchor"></a>
<h3>start<wbr>Compute<wbr>Job</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">start<wbr>Compute<wbr>Job<span class="tsd-signature-symbol">(</span>sasJob<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, config<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, accessToken<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, waitForResult<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span>, pollOptions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/types.polloptions.html" class="tsd-signature-type">PollOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">start<wbr>Compute<wbr>Job<span class="tsd-signature-symbol">(</span>sasJob<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, config<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, accessToken<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, waitForResult<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span>, pollOptions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/types.polloptions.html" class="tsd-signature-type">PollOptions</a>, printPid<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L727">
SASjs.ts:727
<a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L728">
SASjs.ts:728
</a>
</li>
</ul>
@@ -1464,6 +1464,12 @@
<p>an object that represents poll interval(milliseconds) and maximum amount of attempts. Object example: { MAX_POLL_COUNT: 24 * 60 * 60, POLL_INTERVAL: 1000 }.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> printPid: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
<div class="tsd-comment tsd-typography tsd-comment-text">
<p>a boolean that indicates whether the function should print (PID) of the started job.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>an object representing the compute session created for the given job.</p>

View File

@@ -314,8 +314,8 @@
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L684">
SASViyaApiClient.ts:684
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L688">
SASViyaApiClient.ts:688
</a>
</li>
</ul>
@@ -375,8 +375,8 @@
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L770">
SASViyaApiClient.ts:770
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L774">
SASViyaApiClient.ts:774
</a>
</li>
</ul>
@@ -473,8 +473,8 @@
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L957">
SASViyaApiClient.ts:957
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L961">
SASViyaApiClient.ts:961
</a>
</li>
</ul>
@@ -555,8 +555,8 @@
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L1549">
SASViyaApiClient.ts:1549
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L1556">
SASViyaApiClient.ts:1556
</a>
</li>
</ul>
@@ -636,15 +636,15 @@
<a name="executecomputejob" class="tsd-anchor"></a>
<h3>execute<wbr>Compute<wbr>Job</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">execute<wbr>Compute<wbr>Job<span class="tsd-signature-symbol">(</span>sasJob<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, contextName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, debug<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, accessToken<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, waitForResult<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, expectWebout<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, pollOptions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/types.polloptions.html" class="tsd-signature-type">PollOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">execute<wbr>Compute<wbr>Job<span class="tsd-signature-symbol">(</span>sasJob<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, contextName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, debug<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, accessToken<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, waitForResult<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, expectWebout<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, pollOptions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/types.polloptions.html" class="tsd-signature-type">PollOptions</a>, printPid<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L983">
SASViyaApiClient.ts:983
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L988">
SASViyaApiClient.ts:988
</a>
</li>
</ul>
@@ -704,6 +704,12 @@
<p>an object that represents poll interval(milliseconds) and maximum amount of attempts. Object example: { MAX_POLL_COUNT: 24 * 60 * 60, POLL_INTERVAL: 1000 }.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> printPid: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
<div class="tsd-comment tsd-typography tsd-comment-text">
<p>a boolean that indicates whether the function should print (PID) of the started job.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
@@ -720,8 +726,8 @@
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L1089">
SASViyaApiClient.ts:1089
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L1096">
SASViyaApiClient.ts:1096
</a>
</li>
</ul>
@@ -772,15 +778,15 @@
<a name="executescript" class="tsd-anchor"></a>
<h3>execute<wbr>Script</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">execute<wbr>Script<span class="tsd-signature-symbol">(</span>jobPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, linesOfCode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, contextName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, accessToken<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span>, debug<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, expectWebout<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, waitForResult<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, pollOptions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/types.polloptions.html" class="tsd-signature-type">PollOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">execute<wbr>Script<span class="tsd-signature-symbol">(</span>jobPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, linesOfCode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, contextName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, accessToken<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span>, debug<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, expectWebout<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, waitForResult<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, pollOptions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/types.polloptions.html" class="tsd-signature-type">PollOptions</a>, printPid<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L435">
SASViyaApiClient.ts:435
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L436">
SASViyaApiClient.ts:436
</a>
</li>
</ul>
@@ -846,6 +852,12 @@
<p>an object that represents poll interval(milliseconds) and maximum amount of attempts. Object example: { MAX_POLL_COUNT: 24 * 60 * 60, POLL_INTERVAL: 1000 }.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> printPid: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
<div class="tsd-comment tsd-typography tsd-comment-text">
<p>a boolean that indicates whether the function should print (PID) of the started job.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
@@ -862,8 +874,8 @@
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L870">
SASViyaApiClient.ts:870
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L874">
SASViyaApiClient.ts:874
</a>
</li>
</ul>
@@ -944,8 +956,8 @@
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L822">
SASViyaApiClient.ts:822
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L826">
SASViyaApiClient.ts:826
</a>
</li>
</ul>
@@ -979,8 +991,8 @@
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L1461">
SASViyaApiClient.ts:1461
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L1468">
SASViyaApiClient.ts:1468
</a>
</li>
</ul>
@@ -1020,8 +1032,8 @@
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L1430">
SASViyaApiClient.ts:1430
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L1437">
SASViyaApiClient.ts:1437
</a>
</li>
</ul>
@@ -1166,8 +1178,8 @@
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L1490">
SASViyaApiClient.ts:1490
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L1497">
SASViyaApiClient.ts:1497
</a>
</li>
</ul>
@@ -1219,8 +1231,8 @@
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L914">
SASViyaApiClient.ts:914
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L918">
SASViyaApiClient.ts:918
</a>
</li>
</ul>
@@ -1304,8 +1316,8 @@
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L1566">
SASViyaApiClient.ts:1566
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L1573">
SASViyaApiClient.ts:1573
</a>
</li>
</ul>
@@ -1331,8 +1343,8 @@
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L1571">
SASViyaApiClient.ts:1571
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L1578">
SASViyaApiClient.ts:1578
</a>
</li>
</ul>

View File

@@ -431,6 +431,7 @@ export class SASViyaApiClient {
* @param expectWebout - when set to true, the automatic _webout fileref will be checked for content, and that content returned. This fileref is used when the Job contains a SASjs web request (as opposed to executing arbitrary SAS code).
* @param waitForResult - when set to true, function will return the session
* @param pollOptions - an object that represents poll interval(milliseconds) and maximum amount of attempts. Object example: { MAX_POLL_COUNT: 24 * 60 * 60, POLL_INTERVAL: 1000 }.
* @param printPid - a boolean that indicates whether the function should print (PID) of the started job.
*/
public async executeScript(
jobPath: string,
@@ -982,6 +983,7 @@ export class SASViyaApiClient {
* @param waitForResult - a boolean indicating if the function should wait for a result.
* @param expectWebout - a boolean indicating whether to expect a _webout response.
* @param pollOptions - an object that represents poll interval(milliseconds) and maximum amount of attempts. Object example: { MAX_POLL_COUNT: 24 * 60 * 60, POLL_INTERVAL: 1000 }.
* @param printPid - a boolean that indicates whether the function should print (PID) of the started job.
*/
public async executeComputeJob(
sasJob: string,

View File

@@ -723,6 +723,7 @@ export default class SASjs {
* The access token is not required when the user is authenticated via the browser.
* @param waitForResult - a boolean that indicates whether the function needs to wait for execution to complete.
* @param pollOptions - an object that represents poll interval(milliseconds) and maximum amount of attempts. Object example: { MAX_POLL_COUNT: 24 * 60 * 60, POLL_INTERVAL: 1000 }.
* @param printPid - a boolean that indicates whether the function should print (PID) of the started job.
*/
public async startComputeJob(
sasJob: string,