sasjs/adapter
1
0
Fork 0
mirror of https://github.com/sasjs/adapter.git synced 2026-01-06 12:10:04 +00:00
Code Issues Projects Releases Wiki Activity

docs(pid): updated docs

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/classes/root.sasjs.html
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>