sasjs/adapter
1
0
Fork 0
mirror of https://github.com/sasjs/adapter.git synced 2026-01-16 08:30:07 +00:00
Code Issues Projects Releases Wiki Activity

docs(context): add docs for 'getComputeContextByName' method

Browse Source
This commit is contained in:
Yury Shkoda
2020-09-24 16:05:42 +03:00
parent 057460467c
commit e6d0d3efd5
2 changed files with 62 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

103
docs/classes/reflection-759.reflection-211.sasjs.html
View File

@@ -182,8 +182,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#L382"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L387">
SASjs.ts:382 SASjs.ts:387
</a> </a>
</li> </li>
</ul> </ul>
@@ -211,8 +211,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#L1275"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L1280">
SASjs.ts:1275 SASjs.ts:1280
</a> </a>
</li> </li>
</ul> </ul>
@@ -297,8 +297,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#L233"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L238">
SASjs.ts:233 SASjs.ts:238
</a> </a>
</li> </li>
</ul> </ul>
@@ -362,8 +362,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#L259"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L264">
SASjs.ts:259 SASjs.ts:264
</a> </a>
</li> </li>
</ul> </ul>
@@ -404,8 +404,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#L197"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L202">
SASjs.ts:197 SASjs.ts:202
</a> </a>
</li> </li>
</ul> </ul>
@@ -434,8 +434,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#L320"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L325">
SASjs.ts:320 SASjs.ts:325
</a> </a>
</li> </li>
</ul> </ul>
@@ -505,8 +505,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#L577"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L582">
SASjs.ts:577 SASjs.ts:582
</a> </a>
</li> </li>
</ul> </ul>
@@ -647,8 +647,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#L203"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L208">
SASjs.ts:203 SASjs.ts:208
</a> </a>
</li> </li>
</ul> </ul>
@@ -689,8 +689,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#L292"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L297">
SASjs.ts:292 SASjs.ts:297
</a> </a>
</li> </li>
</ul> </ul>
@@ -749,8 +749,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#L286"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L291">
SASjs.ts:286 SASjs.ts:291
</a> </a>
</li> </li>
</ul> </ul>
@@ -776,19 +776,30 @@
<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#L188"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L193">
SASjs.ts:188 SASjs.ts:193
</a> </a>
</li> </li>
</ul> </ul>
</aside> </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>
<h4 class="tsd-parameters-title">Parameters</h4> <h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters"> <ul class="tsd-parameters">
<li> <li>
<h5>contextId: <span class="tsd-signature-type">string</span></h5> <h5>contextId: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography tsd-comment-text">
<p>an id of the context to return.</p>
</div>
</li> </li>
<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> <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> </li>
</ul> </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.contextallattributes.html" class="tsd-signature-type">ContextAllAttributes</a><span class="tsd-signature-symbol">&gt;</span></h4> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/types.contextallattributes.html" class="tsd-signature-type">ContextAllAttributes</a><span class="tsd-signature-symbol">&gt;</span></h4>
@@ -851,8 +862,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#L346"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L351">
SASjs.ts:346 SASjs.ts:351
</a> </a>
</li> </li>
</ul> </ul>
@@ -880,8 +891,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#L354"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L359">
SASjs.ts:354 SASjs.ts:359
</a> </a>
</li> </li>
</ul> </ul>
@@ -936,8 +947,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#L1270"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L1275">
SASjs.ts:1270 SASjs.ts:1275
</a> </a>
</li> </li>
</ul> </ul>
@@ -957,8 +968,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#L330"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L335">
SASjs.ts:330 SASjs.ts:335
</a> </a>
</li> </li>
</ul> </ul>
@@ -983,8 +994,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#L338"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L343">
SASjs.ts:338 SASjs.ts:343
</a> </a>
</li> </li>
</ul> </ul>
@@ -1009,8 +1020,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#L398"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L403">
SASjs.ts:398 SASjs.ts:403
</a> </a>
</li> </li>
</ul> </ul>
@@ -1050,8 +1061,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#L467"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L472">
SASjs.ts:467 SASjs.ts:472
</a> </a>
</li> </li>
</ul> </ul>
@@ -1076,8 +1087,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#L306"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L311">
SASjs.ts:306 SASjs.ts:311
</a> </a>
</li> </li>
</ul> </ul>
@@ -1109,8 +1120,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#L518"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L523">
SASjs.ts:518 SASjs.ts:523
</a> </a>
</li> </li>
</ul> </ul>
@@ -1175,8 +1186,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#L374"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L379">
SASjs.ts:374 SASjs.ts:379
</a> </a>
</li> </li>
</ul> </ul>
@@ -1210,8 +1221,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#L362"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L367">
SASjs.ts:362 SASjs.ts:367
</a> </a>
</li> </li>
</ul> </ul>
@@ -1245,8 +1256,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#L486"> <a href="https://github.com/sasjs/adapter/blob/master/src/SASjs.ts#L491">
SASjs.ts:486 SASjs.ts:491
</a> </a>
</li> </li>
</ul> </ul>

5
src/SASjs.ts
View File

@@ -185,6 +185,11 @@ export default class SASjs {
) )
} }
/**
* Returns a JSON representation of a compute context.
* @param contextId - an id of the context to return.
* @param accessToken - an access token for an authorized user.
*/
public async getComputeContextById(contextId: string, accessToken?: string) { public async getComputeContextById(contextId: string, accessToken?: string) {
this.isMethodSupported('getComputeContextById', ServerType.SASViya) this.isMethodSupported('getComputeContextById', ServerType.SASViya)