sasjs/adapter
1
0
Fork 0
mirror of https://github.com/sasjs/adapter.git synced 2026-01-09 05:20:05 +00:00
Code Issues Projects Releases Wiki Activity

docs(context): update docs related to getComputeContextByName function

Browse Source
This commit is contained in:
Yury Shkoda
2020-09-23 17:21:27 +03:00
parent 491bc3371c
commit d60c0850c2
5 changed files with 126 additions and 113 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/assets/js/search.json
View File

File diff suppressed because one or more lines are too long

108
docs/classes/reflection-734.reflection-194.sasjs.html
View File

@@ -119,7 +119,7 @@
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-734.reflection-194.sasjs.html#getaccesstoken" class="tsd-kind-icon">getAccessToken</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-734.reflection-194.sasjs.html#getaccesstoken" class="tsd-kind-icon">getAccessToken</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-734.reflection-194.sasjs.html#getallcontexts" class="tsd-kind-icon">getAllContexts</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-734.reflection-194.sasjs.html#getallcontexts" class="tsd-kind-icon">getAllContexts</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-734.reflection-194.sasjs.html#getauthcode" class="tsd-kind-icon">getAuthCode</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-734.reflection-194.sasjs.html#getauthcode" class="tsd-kind-icon">getAuthCode</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-734.reflection-194.sasjs.html#getcontextbyname" class="tsd-kind-icon">getContextByName</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-734.reflection-194.sasjs.html#getcomputecontextbyname" class="tsd-kind-icon">getComputeContextByName</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-734.reflection-194.sasjs.html#getcsrfapi" class="tsd-kind-icon">getCsrfApi</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-734.reflection-194.sasjs.html#getcsrfapi" class="tsd-kind-icon">getCsrfApi</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-734.reflection-194.sasjs.html#getcsrfweb" class="tsd-kind-icon">getCsrfWeb</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-734.reflection-194.sasjs.html#getcsrfweb" class="tsd-kind-icon">getCsrfWeb</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-734.reflection-194.sasjs.html#getexecutablecontexts" class="tsd-kind-icon">getExecutableContexts</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-734.reflection-194.sasjs.html#getexecutablecontexts" class="tsd-kind-icon">getExecutableContexts</a></li>
@@ -181,8 +181,8 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L369"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L373">
SASjs.ts:369 SASjs.ts:373
</a> </a>
</li> </li>
</ul> </ul>
@@ -210,8 +210,8 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L1262"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L1266">
SASjs.ts:1262 SASjs.ts:1266
</a> </a>
</li> </li>
</ul> </ul>
@@ -296,8 +296,8 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L220"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L224">
SASjs.ts:220 SASjs.ts:224
</a> </a>
</li> </li>
</ul> </ul>
@@ -361,8 +361,8 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L246"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L250">
SASjs.ts:246 SASjs.ts:250
</a> </a>
</li> </li>
</ul> </ul>
@@ -403,8 +403,8 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L184"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L188">
SASjs.ts:184 SASjs.ts:188
</a> </a>
</li> </li>
</ul> </ul>
@@ -433,8 +433,8 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L307"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L311">
SASjs.ts:307 SASjs.ts:311
</a> </a>
</li> </li>
</ul> </ul>
@@ -504,8 +504,8 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L564"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L568">
SASjs.ts:564 SASjs.ts:568
</a> </a>
</li> </li>
</ul> </ul>
@@ -646,8 +646,8 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L190"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L194">
SASjs.ts:190 SASjs.ts:194
</a> </a>
</li> </li>
</ul> </ul>
@@ -688,8 +688,8 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L279"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L283">
SASjs.ts:279 SASjs.ts:283
</a> </a>
</li> </li>
</ul> </ul>
@@ -748,8 +748,8 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L273"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L277">
SASjs.ts:273 SASjs.ts:277
</a> </a>
</li> </li>
</ul> </ul>
@@ -765,26 +765,30 @@
</ul> </ul>
</section> </section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getcontextbyname" class="tsd-anchor"></a> <a name="getcomputecontextbyname" class="tsd-anchor"></a>
<h3>get<wbr>Context<wbr>ByName</h3> <h3>get<wbr>Compute<wbr>Context<wbr>ByName</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Context<wbr>ByName<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><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><a href="../interfaces/types.context.html" class="tsd-signature-type">Context</a><span class="tsd-signature-symbol">&gt;</span></li> <li class="tsd-signature tsd-kind-icon">get<wbr>Compute<wbr>Context<wbr>ByName<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><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><a href="../interfaces/types.context.html" class="tsd-signature-type">Context</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul> </ul>
<ul class="tsd-descriptions"> <ul class="tsd-descriptions">
<li class="tsd-description"> <li class="tsd-description">
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L175"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L176">
SASjs.ts:175 SASjs.ts:176
</a> </a>
</li> </li>
</ul> </ul>
</aside> </aside>
<div class="tsd-comment tsd-typography tsd-comment-shorttext"> <div class="tsd-comment tsd-typography tsd-comment-shorttext">
<div class="lead"> <div class="lead">
<p>Returns a compute context.</p> <p>Returns a JSON representation of a compute context.</p>
</div> </div>
</div><div class="tsd-comment tsd-typography tsd-comment-tags">
<dl class="tsd-comment-tags"><dt>example:</dt>
<dd><p>{ &quot;createdBy&quot;: &quot;admin&quot;, &quot;links&quot;: [...], &quot;id&quot;: &quot;ID&quot;, &quot;version&quot;: 2, &quot;name&quot;: &quot;context1&quot; }</p>
</dd></dl>
</div> </div>
<h4 class="tsd-parameters-title">Parameters</h4> <h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters"> <ul class="tsd-parameters">
@@ -816,8 +820,8 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L333"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L337">
SASjs.ts:333 SASjs.ts:337
</a> </a>
</li> </li>
</ul> </ul>
@@ -845,8 +849,8 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L341"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L345">
SASjs.ts:341 SASjs.ts:345
</a> </a>
</li> </li>
</ul> </ul>
@@ -901,8 +905,8 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L1257"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L1261">
SASjs.ts:1257 SASjs.ts:1261
</a> </a>
</li> </li>
</ul> </ul>
@@ -922,8 +926,8 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L317"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L321">
SASjs.ts:317 SASjs.ts:321
</a> </a>
</li> </li>
</ul> </ul>
@@ -948,8 +952,8 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L325"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L329">
SASjs.ts:325 SASjs.ts:329
</a> </a>
</li> </li>
</ul> </ul>
@@ -974,8 +978,8 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L385"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L389">
SASjs.ts:385 SASjs.ts:389
</a> </a>
</li> </li>
</ul> </ul>
@@ -1015,8 +1019,8 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L454"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L458">
SASjs.ts:454 SASjs.ts:458
</a> </a>
</li> </li>
</ul> </ul>
@@ -1041,8 +1045,8 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L293"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L297">
SASjs.ts:293 SASjs.ts:297
</a> </a>
</li> </li>
</ul> </ul>
@@ -1074,8 +1078,8 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L505"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L509">
SASjs.ts:505 SASjs.ts:509
</a> </a>
</li> </li>
</ul> </ul>
@@ -1140,8 +1144,8 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L361"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L365">
SASjs.ts:361 SASjs.ts:365
</a> </a>
</li> </li>
</ul> </ul>
@@ -1175,8 +1179,8 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L349"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L353">
SASjs.ts:349 SASjs.ts:353
</a> </a>
</li> </li>
</ul> </ul>
@@ -1210,8 +1214,8 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L473"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L477">
SASjs.ts:473 SASjs.ts:477
</a> </a>
</li> </li>
</ul> </ul>
@@ -1317,7 +1321,7 @@
<a href="reflection-734.reflection-194.sasjs.html#getauthcode" class="tsd-kind-icon">get<wbr>Auth<wbr>Code</a> <a href="reflection-734.reflection-194.sasjs.html#getauthcode" class="tsd-kind-icon">get<wbr>Auth<wbr>Code</a>
</li> </li>
<li class=" tsd-kind-method tsd-parent-kind-class"> <li class=" tsd-kind-method tsd-parent-kind-class">
<a href="reflection-734.reflection-194.sasjs.html#getcontextbyname" class="tsd-kind-icon">get<wbr>Context<wbr>ByName</a> <a href="reflection-734.reflection-194.sasjs.html#getcomputecontextbyname" class="tsd-kind-icon">get<wbr>Compute<wbr>Context<wbr>ByName</a>
</li> </li>
<li class=" tsd-kind-method tsd-parent-kind-class"> <li class=" tsd-kind-method tsd-parent-kind-class">
<a href="reflection-734.reflection-194.sasjs.html#getcsrfapi" class="tsd-kind-icon">get<wbr>Csrf<wbr>Api</a> <a href="reflection-734.reflection-194.sasjs.html#getcsrfapi" class="tsd-kind-icon">get<wbr>Csrf<wbr>Api</a>

108
docs/classes/reflection-734.reflection-194.sasviyaapiclient.html
View File

@@ -118,8 +118,8 @@
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-734.reflection-194.sasviyaapiclient.html#getaccesstoken" class="tsd-kind-icon">getAccessToken</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-734.reflection-194.sasviyaapiclient.html#getaccesstoken" class="tsd-kind-icon">getAccessToken</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-734.reflection-194.sasviyaapiclient.html#getallcontexts" class="tsd-kind-icon">getAllContexts</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-734.reflection-194.sasviyaapiclient.html#getallcontexts" class="tsd-kind-icon">getAllContexts</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-734.reflection-194.sasviyaapiclient.html#getauthcode" class="tsd-kind-icon">getAuthCode</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-734.reflection-194.sasviyaapiclient.html#getauthcode" class="tsd-kind-icon">getAuthCode</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-734.reflection-194.sasviyaapiclient.html#getcomputecontextbyname" class="tsd-kind-icon">getComputeContextByName</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-734.reflection-194.sasviyaapiclient.html#getconfig" class="tsd-kind-icon">getConfig</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-734.reflection-194.sasviyaapiclient.html#getconfig" class="tsd-kind-icon">getConfig</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-734.reflection-194.sasviyaapiclient.html#getcontextbyname" class="tsd-kind-icon">getContextByName</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-734.reflection-194.sasviyaapiclient.html#getexecutablecontexts" class="tsd-kind-icon">getExecutableContexts</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-734.reflection-194.sasviyaapiclient.html#getexecutablecontexts" class="tsd-kind-icon">getExecutableContexts</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-734.reflection-194.sasviyaapiclient.html#getjobsinfolder" class="tsd-kind-icon">getJobsInFolder</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-734.reflection-194.sasviyaapiclient.html#getjobsinfolder" class="tsd-kind-icon">getJobsInFolder</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-734.reflection-194.sasviyaapiclient.html#movefolder" class="tsd-kind-icon">moveFolder</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-734.reflection-194.sasviyaapiclient.html#movefolder" class="tsd-kind-icon">moveFolder</a></li>
@@ -508,8 +508,8 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L1479"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L1480">
SASViyaApiClient.ts:1479 SASViyaApiClient.ts:1480
</a> </a>
</li> </li>
</ul> </ul>
@@ -897,6 +897,51 @@
</li> </li>
</ul> </ul>
</section> </section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getcomputecontextbyname" class="tsd-anchor"></a>
<h3>get<wbr>Compute<wbr>Context<wbr>ByName</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Compute<wbr>Context<wbr>ByName<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><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><a href="../interfaces/types.context.html" class="tsd-signature-type">Context</a><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#L1396">
SASViyaApiClient.ts:1396
</a>
</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
<div class="lead">
<p>Returns a JSON representation of a compute context.</p>
</div>
</div><div class="tsd-comment tsd-typography tsd-comment-tags">
<dl class="tsd-comment-tags"><dt>example:</dt>
<dd><p>{ &quot;createdBy&quot;: &quot;admin&quot;, &quot;links&quot;: [...], &quot;id&quot;: &quot;ID&quot;, &quot;version&quot;: 2, &quot;name&quot;: &quot;context1&quot; }</p>
</dd></dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>contextName: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography tsd-comment-text">
<p>the name of the context to return.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> accessToken: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography tsd-comment-text">
<p>an access token for an authorized user.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/types.context.html" class="tsd-signature-type">Context</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getconfig" class="tsd-anchor"></a> <a name="getconfig" class="tsd-anchor"></a>
<h3>get<wbr>Config</h3> <h3>get<wbr>Config</h3>
@@ -931,47 +976,6 @@
</li> </li>
</ul> </ul>
</section> </section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getcontextbyname" class="tsd-anchor"></a>
<h3>get<wbr>Context<wbr>ByName</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Context<wbr>ByName<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><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><a href="../interfaces/types.context.html" class="tsd-signature-type">Context</a><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#L1395">
SASViyaApiClient.ts:1395
</a>
</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
<div class="lead">
<p>Returns a compute context.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>contextName: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography tsd-comment-text">
<p>the name of the context to return.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> accessToken: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography tsd-comment-text">
<p>an access token for an authorized user.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/types.context.html" class="tsd-signature-type">Context</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getexecutablecontexts" class="tsd-anchor"></a> <a name="getexecutablecontexts" class="tsd-anchor"></a>
<h3>get<wbr>Executable<wbr>Contexts</h3> <h3>get<wbr>Executable<wbr>Contexts</h3>
@@ -1050,8 +1054,8 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L1430"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L1431">
SASViyaApiClient.ts:1430 SASViyaApiClient.ts:1431
</a> </a>
</li> </li>
</ul> </ul>
@@ -1188,8 +1192,8 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L1496"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L1497">
SASViyaApiClient.ts:1496 SASViyaApiClient.ts:1497
</a> </a>
</li> </li>
</ul> </ul>
@@ -1215,8 +1219,8 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <li>Defined in
<a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L1501"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASViyaApiClient.ts#L1502">
SASViyaApiClient.ts:1501 SASViyaApiClient.ts:1502
</a> </a>
</li> </li>
</ul> </ul>
@@ -1294,10 +1298,10 @@
<a href="reflection-734.reflection-194.sasviyaapiclient.html#getauthcode" class="tsd-kind-icon">get<wbr>Auth<wbr>Code</a> <a href="reflection-734.reflection-194.sasviyaapiclient.html#getauthcode" class="tsd-kind-icon">get<wbr>Auth<wbr>Code</a>
</li> </li>
<li class=" tsd-kind-method tsd-parent-kind-class"> <li class=" tsd-kind-method tsd-parent-kind-class">
<a href="reflection-734.reflection-194.sasviyaapiclient.html#getconfig" class="tsd-kind-icon">get<wbr>Config</a> <a href="reflection-734.reflection-194.sasviyaapiclient.html#getcomputecontextbyname" class="tsd-kind-icon">get<wbr>Compute<wbr>Context<wbr>ByName</a>
</li> </li>
<li class=" tsd-kind-method tsd-parent-kind-class"> <li class=" tsd-kind-method tsd-parent-kind-class">
<a href="reflection-734.reflection-194.sasviyaapiclient.html#getcontextbyname" class="tsd-kind-icon">get<wbr>Context<wbr>ByName</a> <a href="reflection-734.reflection-194.sasviyaapiclient.html#getconfig" class="tsd-kind-icon">get<wbr>Config</a>
</li> </li>
<li class=" tsd-kind-method tsd-parent-kind-class"> <li class=" tsd-kind-method tsd-parent-kind-class">
<a href="reflection-734.reflection-194.sasviyaapiclient.html#getexecutablecontexts" class="tsd-kind-icon">get<wbr>Executable<wbr>Contexts</a> <a href="reflection-734.reflection-194.sasviyaapiclient.html#getexecutablecontexts" class="tsd-kind-icon">get<wbr>Executable<wbr>Contexts</a>

9
src/SASViyaApiClient.ts
View File

@@ -313,7 +313,7 @@ export class SASViyaApiClient {
headers.Authorization = `Bearer ${accessToken}` headers.Authorization = `Bearer ${accessToken}`
} }
const originalContext = await this.getContextByName( const originalContext = await this.getComputeContextByName(
contextName, contextName,
accessToken accessToken
) )
@@ -372,7 +372,7 @@ export class SASViyaApiClient {
headers.Authorization = `Bearer ${accessToken}` headers.Authorization = `Bearer ${accessToken}`
} }
const context = await this.getContextByName(contextName, accessToken) const context = await this.getComputeContextByName(contextName, accessToken)
const deleteContextRequest: RequestInit = { const deleteContextRequest: RequestInit = {
method: 'DELETE', method: 'DELETE',
@@ -1388,11 +1388,12 @@ export class SASViyaApiClient {
} }
/** /**
* Returns a compute context. * Returns a JSON representation of a compute context.
* @example: { "createdBy": "admin", "links": [...], "id": "ID", "version": 2, "name": "context1" }
* @param contextName - the name of the context to return. * @param contextName - the name of the context to return.
* @param accessToken - an access token for an authorized user. * @param accessToken - an access token for an authorized user.
*/ */
public async getContextByName( public async getComputeContextByName(
contextName: string, contextName: string,
accessToken?: string accessToken?: string
): Promise<Context> { ): Promise<Context> {

12
src/SASjs.ts
View File

@@ -168,14 +168,18 @@ export default class SASjs {
} }
/** /**
* Returns a compute context. * Returns a JSON representation of a compute context.
* @example: { "createdBy": "admin", "links": [...], "id": "ID", "version": 2, "name": "context1" }
* @param contextName - the name of the context to return. * @param contextName - the name of the context to return.
* @param accessToken - an access token for an authorized user. * @param accessToken - an access token for an authorized user.
*/ */
public async getContextByName(contextName: string, accessToken?: string) { public async getComputeContextByName(
this.isMethodSupported('getContextByName', ServerType.SASViya) contextName: string,
accessToken?: string
) {
this.isMethodSupported('getComputeContextByName', ServerType.SASViya)
return await this.sasViyaApiClient!.getContextByName( return await this.sasViyaApiClient!.getComputeContextByName(
contextName, contextName,
accessToken accessToken
) )