mirror of
https://github.com/sasjs/adapter.git
synced 2025-12-10 17:04:36 +00:00
1670 lines
107 KiB
HTML
1670 lines
107 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>SASjs | @sasjs/adapter</title>
|
|
<meta name="description" content="">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|
</head>
|
|
<body>
|
|
<header>
|
|
<div class="tsd-page-toolbar">
|
|
<div class="container">
|
|
<div class="table-wrap">
|
|
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
|
<div class="field">
|
|
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
<input id="tsd-search-field" type="text" />
|
|
</div>
|
|
<ul class="results">
|
|
<li class="state loading">Preparing search index...</li>
|
|
<li class="state failure">The search index is not available</li>
|
|
</ul>
|
|
<ul class="results-priority" style="display:none">
|
|
</ul>
|
|
<a href="../index.html" class="title">@sasjs/adapter</a>
|
|
 <a href="https://github.com/sasjs/adapter" class="title">SASjs on Github</a>
|
|
 <a href="https://sasjs.io" class="title">SASjs.io</a>
|
|
 <a href="https://github.com/sasjs/cli" class="title">SASjs CLI</a>
|
|
 <a href="https://github.com/sasjs/react-seed-app" class="title">React Seed App</a>
|
|
</div>
|
|
<div class="table-cell" id="tsd-widgets">
|
|
<div id="tsd-filter">
|
|
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
<div class="tsd-filter-group">
|
|
<div class="tsd-select" id="tsd-filter-visibility">
|
|
<span class="tsd-select-label">All</span>
|
|
<ul class="tsd-select-list">
|
|
<li data-value="public">Public</li>
|
|
<li data-value="protected">Public/Protected</li>
|
|
<li data-value="private" class="selected">All</li>
|
|
</ul>
|
|
</div>
|
|
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
</div>
|
|
</div>
|
|
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="tsd-page-title">
|
|
<div class="container">
|
|
<ul class="tsd-breadcrumb">
|
|
<li>
|
|
<a href="../modules/reflection-804.html"></a>
|
|
</li>
|
|
<li>
|
|
<a href="../modules/reflection-804.reflection-219.html"></a>
|
|
</li>
|
|
<li>
|
|
<a href="reflection-804.reflection-219.sasjs.html">SASjs</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container container-main">
|
|
<div class="row">
|
|
<div class="col-3 col-menu menu-sticky-wrap menu-highlight">
|
|
<nav class="tsd-navigation outline primary">
|
|
<a style="margin-left:0em" href="../globals.html">Globals</a>
|
|
<ul style="display:none">
|
|
{"SAS Adapter":{"SASjs":"classes/reflection-717.reflection-180.sasjs","Types":"modules/types"},"SAS Viya API Client":"classes/reflection-717.reflection-180.sasviyaapiclient","SAS 9 API Client":"classes/reflection-717.reflection-180.sas9apiclient"}
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
<div class="col-7 offset-3 col-content">
|
|
<h1>Class SASjs</h1>
|
|
<section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography tsd-comment-shorttext">
|
|
<div class="lead">
|
|
<p>SASjs is a JavaScript adapter for SAS.</p>
|
|
</div>
|
|
</div></section>
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h3>Hierarchy</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="target">SASjs</span>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-index-group">
|
|
<section class="tsd-panel tsd-index-panel">
|
|
<div class="tsd-index-content">
|
|
<section class="tsd-index-section ">
|
|
<h3>Constructors</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="reflection-804.reflection-219.sasjs.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Methods</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-804.reflection-219.sasjs.html#checksession" class="tsd-kind-icon">checkSession</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-804.reflection-219.sasjs.html#clearsasrequests" class="tsd-kind-icon">clearSasRequests</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-804.reflection-219.sasjs.html#createcontext" class="tsd-kind-icon">createContext</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-804.reflection-219.sasjs.html#createfolder" class="tsd-kind-icon">createFolder</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-804.reflection-219.sasjs.html#createjobdefinition" class="tsd-kind-icon">createJobDefinition</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-804.reflection-219.sasjs.html#createsession" class="tsd-kind-icon">createSession</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-804.reflection-219.sasjs.html#deleteclient" class="tsd-kind-icon">deleteClient</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-804.reflection-219.sasjs.html#deletecontext" class="tsd-kind-icon">deleteContext</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-804.reflection-219.sasjs.html#deletefolder" class="tsd-kind-icon">deleteFolder</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-804.reflection-219.sasjs.html#deployservicepack" class="tsd-kind-icon">deployServicePack</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-804.reflection-219.sasjs.html#editcontext" class="tsd-kind-icon">editContext</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-804.reflection-219.sasjs.html#executescriptsas9" class="tsd-kind-icon">executeScriptSAS9</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-804.reflection-219.sasjs.html#executescriptsasviya" class="tsd-kind-icon">executeScriptSASViya</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-804.reflection-219.sasjs.html#fetchlogfilecontent" class="tsd-kind-icon">fetchLogFileContent</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-804.reflection-219.sasjs.html#getaccesstoken" class="tsd-kind-icon">getAccessToken</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-804.reflection-219.sasjs.html#getallcontexts" class="tsd-kind-icon">getAllContexts</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-804.reflection-219.sasjs.html#getauthcode" class="tsd-kind-icon">getAuthCode</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-804.reflection-219.sasjs.html#getcomputecontextbyid" class="tsd-kind-icon">getComputeContextById</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-804.reflection-219.sasjs.html#getcomputecontextbyname" class="tsd-kind-icon">getComputeContextByName</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-804.reflection-219.sasjs.html#getcsrfapi" class="tsd-kind-icon">getCsrfApi</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-804.reflection-219.sasjs.html#getcsrfweb" class="tsd-kind-icon">getCsrfWeb</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-804.reflection-219.sasjs.html#getexecutablecontexts" class="tsd-kind-icon">getExecutableContexts</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-804.reflection-219.sasjs.html#getsasrequests" class="tsd-kind-icon">getSasRequests</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-804.reflection-219.sasjs.html#getsasjsconfig" class="tsd-kind-icon">getSasjsConfig</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-804.reflection-219.sasjs.html#getusername" class="tsd-kind-icon">getUserName</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-804.reflection-219.sasjs.html#login" class="tsd-kind-icon">logIn</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-804.reflection-219.sasjs.html#logout" class="tsd-kind-icon">logOut</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-804.reflection-219.sasjs.html#movefolder" class="tsd-kind-icon">moveFolder</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-804.reflection-219.sasjs.html#refreshtokens" class="tsd-kind-icon">refreshTokens</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-804.reflection-219.sasjs.html#request" class="tsd-kind-icon">request</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-804.reflection-219.sasjs.html#setdebugstate" class="tsd-kind-icon">setDebugState</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-804.reflection-219.sasjs.html#setsasjsconfig" class="tsd-kind-icon">setSASjsConfig</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-804.reflection-219.sasjs.html#startcomputejob" class="tsd-kind-icon">startComputeJob</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reflection-804.reflection-219.sasjs.html#uploadfile" class="tsd-kind-icon">uploadFile</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Constructors</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
|
<a name="constructor" class="tsd-anchor"></a>
|
|
<h3>constructor</h3>
|
|
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">new SASjs<span class="tsd-signature-symbol">(</span>config<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="reflection-804.reflection-219.sasjs.html" class="tsd-signature-type">SASjs</a></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#L74">
|
|
SASjs.ts:74
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> config: <span class="tsd-signature-type">any</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="reflection-804.reflection-219.sasjs.html" class="tsd-signature-type">SASjs</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Methods</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="checksession" class="tsd-anchor"></a>
|
|
<h3>check<wbr>Session</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">check<wbr>Session<span class="tsd-signature-symbol">(</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"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></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#L452">
|
|
SASjs.ts:452
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
|
|
<div class="lead">
|
|
<p>Checks whether a session is active, or login is required.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></h4>
|
|
<ul>
|
|
<li>a promise which resolves with an object containing two values - a boolean <code>isLoggedIn</code>, and a string <code>userName</code>.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="clearsasrequests" class="tsd-anchor"></a>
|
|
<h3>clear<wbr>Sas<wbr>Requests</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">clear<wbr>Sas<wbr>Requests<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</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#L1449">
|
|
SASjs.ts:1449
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="createcontext" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Context</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Context<span class="tsd-signature-symbol">(</span>contextName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, launchContextName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, sharedAccountId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, autoExecLines<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, accessToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, authorizedUsers<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-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types.context.html" class="tsd-signature-type">Context</a><span class="tsd-signature-symbol">></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#L120">
|
|
SASjs.ts:120
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
|
|
<div class="lead">
|
|
<p>Creates a compute context on the given server.</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 be created.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>launchContextName: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography tsd-comment-text">
|
|
<p>the name of the launcher context used by the compute service.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>sharedAccountId: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography tsd-comment-text">
|
|
<p>the ID of the account to run the servers for this context as.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>autoExecLines: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
<div class="tsd-comment tsd-typography tsd-comment-text">
|
|
<p>the lines of code to execute during session initialization.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>accessToken: <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>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> authorizedUsers: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
<div class="tsd-comment tsd-typography tsd-comment-text">
|
|
<p>an optional list of authorized user IDs.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types.context.html" class="tsd-signature-type">Context</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="createfolder" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Folder</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Folder<span class="tsd-signature-symbol">(</span>folderName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, parentFolderPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, parentFolderUri<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>, 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>, sasApiClient<span class="tsd-signature-symbol">?: </span><a href="reflection-804.reflection-219.sasviyaapiclient.html" class="tsd-signature-type">SASViyaApiClient</a>, isForced<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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types.folder.html" class="tsd-signature-type">Folder</a><span class="tsd-signature-symbol">></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#L245">
|
|
SASjs.ts:245
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
|
|
<div class="lead">
|
|
<p>Creates a folder at SAS file system.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>folderName: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography tsd-comment-text">
|
|
<p>name of the folder to be created.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>parentFolderPath: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography tsd-comment-text">
|
|
<p>the full path (eg <code>/Public/example/myFolder</code>) of the parent folder.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> parentFolderUri: <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>the URI of the parent folder.</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>the access token to authorizing the request.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> sasApiClient: <a href="reflection-804.reflection-219.sasviyaapiclient.html" class="tsd-signature-type">SASViyaApiClient</a></h5>
|
|
<div class="tsd-comment tsd-typography tsd-comment-text">
|
|
<p>a client for interfacing with SAS API.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> isForced: <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></h5>
|
|
<div class="tsd-comment tsd-typography tsd-comment-text">
|
|
<p>flag that indicates if target folder already exists, it and all subfolders have to be deleted. Applicable for SAS VIYA only.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types.folder.html" class="tsd-signature-type">Folder</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="createjobdefinition" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Job<wbr>Definition</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Job<wbr>Definition<span class="tsd-signature-symbol">(</span>jobName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, parentFolderPath<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>, parentFolderUri<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>, 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>, sasApiClient<span class="tsd-signature-symbol">?: </span><a href="reflection-804.reflection-219.sasviyaapiclient.html" class="tsd-signature-type">SASViyaApiClient</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"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></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#L303">
|
|
SASjs.ts:303
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>jobName: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>code: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> parentFolderPath: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> parentFolderUri: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
|
|
</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>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> sasApiClient: <a href="reflection-804.reflection-219.sasviyaapiclient.html" class="tsd-signature-type">SASViyaApiClient</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="createsession" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Session</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Session<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">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"><</span><a href="../interfaces/types.session.html" class="tsd-signature-type">Session</a><span class="tsd-signature-symbol">></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#L203">
|
|
SASjs.ts:203
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>contextName: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>accessToken: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types.session.html" class="tsd-signature-type">Session</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="deleteclient" class="tsd-anchor"></a>
|
|
<h3>delete<wbr>Client</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">delete<wbr>Client<span class="tsd-signature-symbol">(</span>clientId<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">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"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></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#L364">
|
|
SASjs.ts:364
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>clientId: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>accessToken: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="deletecontext" class="tsd-anchor"></a>
|
|
<h3>delete<wbr>Context</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">delete<wbr>Context<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"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></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#L165">
|
|
SASjs.ts:165
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
|
|
<div class="lead">
|
|
<p>Deletes a compute context on the given server.</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 be deleted.</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"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="deletefolder" class="tsd-anchor"></a>
|
|
<h3>delete<wbr>Folder</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">delete<wbr>Folder<span class="tsd-signature-symbol">(</span>folderPath<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">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"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/types.folder.html" class="tsd-signature-type">Folder</a><span class="tsd-signature-symbol">></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#L274">
|
|
SASjs.ts:274
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
|
|
<div class="lead">
|
|
<p>For performance (and in case of accidental error) the <code>deleteFolder</code> function does not actually delete the folder (and all its content and subfolder content). Instead the folder is simply moved to the recycle bin. Deletion time will be added to the folder name.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>folderPath: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography tsd-comment-text">
|
|
<p>the full path (eg <code>/Public/example/deleteThis</code>) of the folder to be deleted.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>accessToken: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography tsd-comment-text">
|
|
<p>an access token for authorizing the request.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/types.folder.html" class="tsd-signature-type">Folder</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="deployservicepack" class="tsd-anchor"></a>
|
|
<h3>deploy<wbr>Service<wbr>Pack</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">deploy<wbr>Service<wbr>Pack<span class="tsd-signature-symbol">(</span>serviceJson<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, appLoc<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>, serverUrl<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>, 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>, isForced<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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></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#L651">
|
|
SASjs.ts:651
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
|
|
<div class="lead">
|
|
<p>Creates the folders and services at the given location <code>appLoc</code> on the given server <code>serverUrl</code>.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>serviceJson: <span class="tsd-signature-type">any</span></h5>
|
|
<div class="tsd-comment tsd-typography tsd-comment-text">
|
|
<p>the JSON specifying the folders and services to be created.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> appLoc: <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>the base folder in which to create the new folders and
|
|
services. If not provided, is taken from SASjsConfig.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> serverUrl: <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>the server on which to deploy the folders and services.
|
|
If not provided, is taken from SASjsConfig.</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 optional access token to be passed in when
|
|
using this function from the command line.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> isForced: <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>flag that indicates if target folder already exists, it and all subfolders have to be deleted.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="editcontext" class="tsd-anchor"></a>
|
|
<h3>edit<wbr>Context</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">edit<wbr>Context<span class="tsd-signature-symbol">(</span>contextName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, editedContext<span class="tsd-signature-symbol">: </span><a href="../interfaces/types.editcontextinput.html" class="tsd-signature-type">EditContextInput</a>, 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"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></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#L146">
|
|
SASjs.ts:146
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
|
|
<div class="lead">
|
|
<p>Updates a compute context on the given server.</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 original name of the context to be deleted.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>editedContext: <a href="../interfaces/types.editcontextinput.html" class="tsd-signature-type">EditContextInput</a></h5>
|
|
<div class="tsd-comment tsd-typography tsd-comment-text">
|
|
<p>an object with the properties to be updated.</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"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="executescriptsas9" class="tsd-anchor"></a>
|
|
<h3>execute<wbr>ScriptSAS9</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">execute<wbr>ScriptSAS9<span class="tsd-signature-symbol">(</span>linesOfCode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, serverName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, repositoryName<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"><</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></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#L85">
|
|
SASjs.ts:85
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>linesOfCode: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>serverName: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>repositoryName: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><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></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="executescriptsasviya" class="tsd-anchor"></a>
|
|
<h3>execute<wbr>ScriptSASViya</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">execute<wbr>ScriptSASViya<span class="tsd-signature-symbol">(</span>fileName<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>, 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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></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#L217">
|
|
SASjs.ts:217
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
|
|
<div class="lead">
|
|
<p>Executes the sas code against given sas server</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>fileName: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography tsd-comment-text">
|
|
<p>name of the file to run.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>linesOfCode: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
<div class="tsd-comment tsd-typography tsd-comment-text">
|
|
<p>lines of sas code from the file to run.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>contextName: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography tsd-comment-text">
|
|
<p>context name override on which code will be run.</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>the access tokne to authorizing the request.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> debug: <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></h5>
|
|
<div class="tsd-comment tsd-typography tsd-comment-text">
|
|
<p>debug flag override</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="fetchlogfilecontent" class="tsd-anchor"></a>
|
|
<h3>fetch<wbr>Log<wbr>File<wbr>Content</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">fetch<wbr>Log<wbr>File<wbr>Content<span class="tsd-signature-symbol">(</span>logLink<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"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></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#L1352">
|
|
SASjs.ts:1352
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
|
|
<div class="lead">
|
|
<p>Fetches content of the log file</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>logLink: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography tsd-comment-text">
|
|
<p>url of the log file.</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"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="getaccesstoken" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Access<wbr>Token</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Access<wbr>Token<span class="tsd-signature-symbol">(</span>clientId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, clientSecret<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, authCode<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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></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#L336">
|
|
SASjs.ts:336
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>clientId: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>clientSecret: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>authCode: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="getallcontexts" class="tsd-anchor"></a>
|
|
<h3>get<wbr>All<wbr>Contexts</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>All<wbr>Contexts<span class="tsd-signature-symbol">(</span>accessToken<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"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></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#L99">
|
|
SASjs.ts:99
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>accessToken: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="getauthcode" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Auth<wbr>Code</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Auth<wbr>Code<span class="tsd-signature-symbol">(</span>clientId<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"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></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#L330">
|
|
SASjs.ts:330
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>clientId: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="getcomputecontextbyid" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Compute<wbr>Context<wbr>ById</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>ById<span class="tsd-signature-symbol">(</span>contextId<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"><</span><a href="../interfaces/types.contextallattributes.html" class="tsd-signature-type">ContextAllAttributes</a><span class="tsd-signature-symbol">></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#L194">
|
|
SASjs.ts:194
|
|
</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>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<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>
|
|
<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"><</span><a href="../interfaces/types.contextallattributes.html" class="tsd-signature-type">ContextAllAttributes</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</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"><</span><a href="../interfaces/types.context.html" class="tsd-signature-type">Context</a><span class="tsd-signature-symbol">></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#L177">
|
|
SASjs.ts:177
|
|
</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>{ "createdBy": "admin", "links": [...], "id": "ID", "version": 2, "name": "context1" }</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"><</span><a href="../interfaces/types.context.html" class="tsd-signature-type">Context</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="getcsrfapi" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Csrf<wbr>Api</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Csrf<wbr>Api<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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></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#L390">
|
|
SASjs.ts:390
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
|
|
<div class="lead">
|
|
<p>Returns the _csrf token of the current session for the API approach.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span>
|
|
<span class="tsd-signature-symbol"> | </span>
|
|
<span class="tsd-signature-type">string</span>
|
|
</h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="getcsrfweb" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Csrf<wbr>Web</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Csrf<wbr>Web<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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></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#L398">
|
|
SASjs.ts:398
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
|
|
<div class="lead">
|
|
<p>Returns the _csrf token of the current session for the WEB approach.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span>
|
|
<span class="tsd-signature-symbol"> | </span>
|
|
<span class="tsd-signature-type">string</span>
|
|
</h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="getexecutablecontexts" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Executable<wbr>Contexts</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Executable<wbr>Contexts<span class="tsd-signature-symbol">(</span>accessToken<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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></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#L105">
|
|
SASjs.ts:105
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>accessToken: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="getsasrequests" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Sas<wbr>Requests</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Sas<wbr>Requests<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/types.sasjsrequest.html" class="tsd-signature-type">SASjsRequest</a><span class="tsd-signature-symbol">[]</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#L1444">
|
|
SASjs.ts:1444
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/types.sasjsrequest.html" class="tsd-signature-type">SASjsRequest</a><span class="tsd-signature-symbol">[]</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="getsasjsconfig" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Sasjs<wbr>Config</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Sasjs<wbr>Config<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="types.sasjsconfig.html" class="tsd-signature-type">SASjsConfig</a></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#L374">
|
|
SASjs.ts:374
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
|
|
<div class="lead">
|
|
<p>Returns the current SASjs configuration.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <a href="types.sasjsconfig.html" class="tsd-signature-type">SASjsConfig</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="getusername" class="tsd-anchor"></a>
|
|
<h3>get<wbr>User<wbr>Name</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>User<wbr>Name<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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#L382">
|
|
SASjs.ts:382
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
|
|
<div class="lead">
|
|
<p>Returns the username of the user currently logged in.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="login" class="tsd-anchor"></a>
|
|
<h3>log<wbr>In</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">log<wbr>In<span class="tsd-signature-symbol">(</span>username<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, password<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"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></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#L474">
|
|
SASjs.ts:474
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
|
|
<div class="lead">
|
|
<p>Logs into the SAS server with the supplied credentials.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>username: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography tsd-comment-text">
|
|
<p>a string representing the username.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>password: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography tsd-comment-text">
|
|
<p>a string representing the password.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="logout" class="tsd-anchor"></a>
|
|
<h3>log<wbr>Out</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">log<wbr>Out<span class="tsd-signature-symbol">(</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"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></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#L541">
|
|
SASjs.ts:541
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
|
|
<div class="lead">
|
|
<p>Logs out of the configured SAS server.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="movefolder" class="tsd-anchor"></a>
|
|
<h3>move<wbr>Folder</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">move<wbr>Folder<span class="tsd-signature-symbol">(</span>sourceFolder<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, targetParentFolder<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, targetFolderName<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">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"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/types.folder.html" class="tsd-signature-type">Folder</a><span class="tsd-signature-symbol">></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#L287">
|
|
SASjs.ts:287
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
|
|
<div class="lead">
|
|
<p>Moves folder to a new location. The folder may be renamed at the same time.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>sourceFolder: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography tsd-comment-text">
|
|
<p>the full path (eg <code>/Public/example/myFolder</code>) or URI of the source folder to be moved. Providing URI instead of path will save one extra request.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>targetParentFolder: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography tsd-comment-text">
|
|
<p>the full path or URI of the <em>parent</em> folder to which the <code>sourceFolder</code> will be moved (eg <code>/Public/newDestination</code>). To move a folder, a user has to have write permissions in targetParentFolder. Providing URI instead of path will save one extra request.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>targetFolderName: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography tsd-comment-text">
|
|
<p>the name of the "moved" folder. If left blank, the original folder name will be used (eg <code>myFolder</code> in <code>/Public/newDestination/myFolder</code> for the example above). Optional field.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>accessToken: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography tsd-comment-text">
|
|
<p>an access token for authorizing the request.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/types.folder.html" class="tsd-signature-type">Folder</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="refreshtokens" class="tsd-anchor"></a>
|
|
<h3>refresh<wbr>Tokens</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">refresh<wbr>Tokens<span class="tsd-signature-symbol">(</span>clientId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, clientSecret<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, refreshToken<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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></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#L350">
|
|
SASjs.ts:350
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>clientId: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>clientSecret: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>refreshToken: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="request" class="tsd-anchor"></a>
|
|
<h3>request</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">request<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>, loginRequiredCallback<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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></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#L592">
|
|
SASjs.ts:592
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
|
|
<div class="lead">
|
|
<p>Makes a request to the SAS Service specified in <code>SASjob</code>. The response
|
|
object will always contain table names in lowercase, and column names in
|
|
uppercase. Values are returned formatted by default, unformatted
|
|
values can be configured as an option in the <code>%webout</code> macro.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>sasJob: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography tsd-comment-text">
|
|
<p>the path to the SAS program (ultimately resolves to
|
|
the SAS <code>_program</code> parameter to run a Job Definition or SAS 9 Stored
|
|
Process). Is prepended at runtime with the value of <code>appLoc</code>.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>data: <span class="tsd-signature-type">any</span></h5>
|
|
<div class="tsd-comment tsd-typography tsd-comment-text">
|
|
<p>a JSON object containing one or more tables to be sent to
|
|
SAS. Can be <code>null</code> if no inputs required.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> config: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
|
<div class="tsd-comment tsd-typography tsd-comment-text">
|
|
<p>provide any changes to the config here, for instance to
|
|
enable/disable <code>debug</code>. Any change provided will override the global config,
|
|
for that particular function call.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> loginRequiredCallback: <span class="tsd-signature-type">any</span></h5>
|
|
<div class="tsd-comment tsd-typography tsd-comment-text">
|
|
<p>provide a function here to be called if the
|
|
user is not logged in (eg to display a login form). The request will be
|
|
resubmitted after logon.</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>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="setdebugstate" class="tsd-anchor"></a>
|
|
<h3>set<wbr>Debug<wbr>State</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">set<wbr>Debug<wbr>State<span class="tsd-signature-symbol">(</span>value<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">void</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#L418">
|
|
SASjs.ts:418
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
|
|
<div class="lead">
|
|
<p>Sets the debug state. Turning this on will enable additional logging in the adapter.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>value: <span class="tsd-signature-type">boolean</span></h5>
|
|
<div class="tsd-comment tsd-typography tsd-comment-text">
|
|
<p>boolean indicating debug state (on/off).</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="setsasjsconfig" class="tsd-anchor"></a>
|
|
<h3>setSASjs<wbr>Config</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">setSASjs<wbr>Config<span class="tsd-signature-symbol">(</span>config<span class="tsd-signature-symbol">: </span><a href="types.sasjsconfig.html" class="tsd-signature-type">SASjsConfig</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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></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#L406">
|
|
SASjs.ts:406
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
|
|
<div class="lead">
|
|
<p>Sets the SASjs configuration.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>config: <a href="types.sasjsconfig.html" class="tsd-signature-type">SASjsConfig</a></h5>
|
|
<div class="tsd-comment tsd-typography tsd-comment-text">
|
|
<p>SASjs configuration.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<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"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></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>
|
|
</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
|
|
<div class="lead">
|
|
<p>Kicks off execution of the given job via the compute API.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>sasJob: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography tsd-comment-text">
|
|
<p>the path to the SAS program (ultimately resolves to
|
|
the SAS <code>_program</code> parameter to run a Job Definition or SAS 9 Stored
|
|
Process). Is prepended at runtime with the value of <code>appLoc</code>.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>data: <span class="tsd-signature-type">any</span></h5>
|
|
<div class="tsd-comment tsd-typography tsd-comment-text">
|
|
<p>a JSON object containing one or more tables to be sent to
|
|
SAS. Can be <code>null</code> if no inputs required.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> config: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
|
<div class="tsd-comment tsd-typography tsd-comment-text">
|
|
<p>provide any changes to the config here, for instance to
|
|
enable/disable <code>debug</code>. Any change provided will override the global config,
|
|
for that particular function call.</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>a valid access token that is authorised to execute compute jobs.
|
|
The access token is not required when the user is authenticated via the browser.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> waitForResult: <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></h5>
|
|
<div class="tsd-comment tsd-typography tsd-comment-text">
|
|
<p>a boolean that indicates whether the function needs to wait for execution to complete.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> pollOptions: <a href="../interfaces/types.polloptions.html" class="tsd-signature-type">PollOptions</a></h5>
|
|
<div class="tsd-comment tsd-typography tsd-comment-text">
|
|
<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>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
|
|
<p>an object representing the compute session created for the given job.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="uploadfile" class="tsd-anchor"></a>
|
|
<h3>upload<wbr>File</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">upload<wbr>File<span class="tsd-signature-symbol">(</span>sasJob<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, files<span class="tsd-signature-symbol">: </span><a href="../interfaces/types.uploadfile.html" class="tsd-signature-type">UploadFile</a><span class="tsd-signature-symbol">[]</span>, params<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></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#L560">
|
|
SASjs.ts:560
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
|
|
<div class="lead">
|
|
<p>Uploads a file to the given service.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>sasJob: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography tsd-comment-text">
|
|
<p>the path to the SAS program (ultimately resolves to
|
|
the SAS <code>_program</code> parameter to run a Job Definition or SAS 9 Stored
|
|
Process). Is prepended at runtime with the value of <code>appLoc</code>.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>files: <a href="../interfaces/types.uploadfile.html" class="tsd-signature-type">UploadFile</a><span class="tsd-signature-symbol">[]</span></h5>
|
|
<div class="tsd-comment tsd-typography tsd-comment-text">
|
|
<p>array of files to be uploaded, including File object and file name.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>params: <span class="tsd-signature-type">any</span></h5>
|
|
<div class="tsd-comment tsd-typography tsd-comment-text">
|
|
<p>request URL parameters.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
<!--{"options":"/home/mihajlo/shared-projects/macro-people/sasjs/adapter","tsconfig":"/home/mihajlo/shared-projects/macro-people/sasjs/adapter","inputFiles":["/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/FileUploader.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/SAS9ApiClient.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/SASViyaApiClient.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/SASjs.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/SessionManager.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/index.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/types/Context.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/types/CsrfToken.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/types/ErrorResponse.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/types/Folder.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/types/Job.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/types/JobDefinition.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/types/JobResult.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/types/Link.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/types/PollOptions.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/types/SASjsConfig.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/types/SASjsRequest.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/types/SASjsWaitingRequest.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/types/ServerType.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/types/Session.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/types/UploadFile.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/types/index.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/utils/asyncForEach.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/utils/compareTimestamps.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/utils/convertToCsv.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/utils/formatDataForRequest.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/utils/index.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/utils/isAuthorizeFormRequired.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/utils/isIeOrEdge.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/utils/isLoginRequired.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/utils/isLoginSuccess.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/utils/isRelativePath.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/utils/isUri.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/utils/isUrl.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/utils/makeRequest.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/utils/needsRetry.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/utils/parseAndSubmitAuthorizeForm.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/utils/parseGeneratedCode.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/utils/parseSasViyaLog.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/utils/parseSourceCode.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/utils/parseWeboutResponse.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/utils/serialize.ts","/home/mihajlo/shared-projects/macro-people/sasjs/adapter/src/utils/splitChunks.ts"],"mode":1,"includeDeclarations":true,"entryPoint":"","exclude":["**/*+(index|.spec|.e2e).ts"],"externalPattern":[],"excludeExternals":true,"excludeNotExported":true,"excludeNotDocumented":false,"excludePrivate":true,"excludeProtected":false,"ignoreCompilerErrors":true,"disableSources":false,"includes":"","media":"","out":"docs","json":"","theme":"./node_modules/typedoc-neo-theme/bin/default","name":"","includeVersion":false,"excludeTags":[],"readme":"","defaultCategory":"Other","categoryOrder":[],"categorizeByGroup":true,"gitRevision":"","gitRemote":"origin","gaID":"","gaSite":"auto","hideGenerator":false,"toc":[],"disableOutputCheck":true,"help":false,"version":false,"plugin":[],"logger":"console","listInvalidSymbolLinks":false,"links":[{"label":"SASjs on Github","url":"https://github.com/sasjs/adapter"},{"label":"SASjs.io","url":"https://sasjs.io"},{"label":"SASjs CLI","url":"https://github.com/sasjs/cli"},{"label":"React Seed App","url":"https://github.com/sasjs/react-seed-app"}],"outline":[{"SAS Adapter":{"SASjs":"classes/reflection-717.reflection-180.sasjs","Types":"modules/types"},"SAS Viya API Client":"classes/reflection-717.reflection-180.sasviyaapiclient","SAS 9 API Client":"classes/reflection-717.reflection-180.sas9apiclient"}],"source":[{"path":"https://github.com/sasjs/adapter/blob/master/src/","line":"L"}],"disableAutoModuleName":"false"}-->
|
|
</div>
|
|
<div class="col-2 col-menu secondary-menu">
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
<li class=" tsd-kind-class tsd-parent-kind-module root">
|
|
<a href="reflection-804.reflection-219.fileuploader.html" class="tsd-kind-icon">File<wbr>Uploader</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module root">
|
|
<a href="reflection-804.reflection-219.sas9apiclient.html" class="tsd-kind-icon">SAS9<wbr>Api<wbr>Client</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module root">
|
|
<a href="reflection-804.reflection-219.sasviyaapiclient.html" class="tsd-kind-icon">SASViya<wbr>Api<wbr>Client</a>
|
|
</li>
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="current tsd-kind-class tsd-parent-kind-module root">
|
|
<a href="reflection-804.reflection-219.sasjs.html" class="tsd-kind-icon">SASjs</a>
|
|
<ul>
|
|
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
|
<a href="reflection-804.reflection-219.sasjs.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="reflection-804.reflection-219.sasjs.html#checksession" class="tsd-kind-icon">check<wbr>Session</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="reflection-804.reflection-219.sasjs.html#clearsasrequests" class="tsd-kind-icon">clear<wbr>Sas<wbr>Requests</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="reflection-804.reflection-219.sasjs.html#createcontext" class="tsd-kind-icon">create<wbr>Context</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="reflection-804.reflection-219.sasjs.html#createfolder" class="tsd-kind-icon">create<wbr>Folder</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="reflection-804.reflection-219.sasjs.html#createjobdefinition" class="tsd-kind-icon">create<wbr>Job<wbr>Definition</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="reflection-804.reflection-219.sasjs.html#createsession" class="tsd-kind-icon">create<wbr>Session</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="reflection-804.reflection-219.sasjs.html#deleteclient" class="tsd-kind-icon">delete<wbr>Client</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="reflection-804.reflection-219.sasjs.html#deletecontext" class="tsd-kind-icon">delete<wbr>Context</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="reflection-804.reflection-219.sasjs.html#deletefolder" class="tsd-kind-icon">delete<wbr>Folder</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="reflection-804.reflection-219.sasjs.html#deployservicepack" class="tsd-kind-icon">deploy<wbr>Service<wbr>Pack</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="reflection-804.reflection-219.sasjs.html#editcontext" class="tsd-kind-icon">edit<wbr>Context</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="reflection-804.reflection-219.sasjs.html#executescriptsas9" class="tsd-kind-icon">execute<wbr>ScriptSAS9</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="reflection-804.reflection-219.sasjs.html#executescriptsasviya" class="tsd-kind-icon">execute<wbr>ScriptSASViya</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="reflection-804.reflection-219.sasjs.html#fetchlogfilecontent" class="tsd-kind-icon">fetch<wbr>Log<wbr>File<wbr>Content</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="reflection-804.reflection-219.sasjs.html#getaccesstoken" class="tsd-kind-icon">get<wbr>Access<wbr>Token</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="reflection-804.reflection-219.sasjs.html#getallcontexts" class="tsd-kind-icon">get<wbr>All<wbr>Contexts</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="reflection-804.reflection-219.sasjs.html#getauthcode" class="tsd-kind-icon">get<wbr>Auth<wbr>Code</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="reflection-804.reflection-219.sasjs.html#getcomputecontextbyid" class="tsd-kind-icon">get<wbr>Compute<wbr>Context<wbr>ById</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="reflection-804.reflection-219.sasjs.html#getcomputecontextbyname" class="tsd-kind-icon">get<wbr>Compute<wbr>Context<wbr>ByName</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="reflection-804.reflection-219.sasjs.html#getcsrfapi" class="tsd-kind-icon">get<wbr>Csrf<wbr>Api</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="reflection-804.reflection-219.sasjs.html#getcsrfweb" class="tsd-kind-icon">get<wbr>Csrf<wbr>Web</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="reflection-804.reflection-219.sasjs.html#getexecutablecontexts" class="tsd-kind-icon">get<wbr>Executable<wbr>Contexts</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="reflection-804.reflection-219.sasjs.html#getsasrequests" class="tsd-kind-icon">get<wbr>Sas<wbr>Requests</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="reflection-804.reflection-219.sasjs.html#getsasjsconfig" class="tsd-kind-icon">get<wbr>Sasjs<wbr>Config</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="reflection-804.reflection-219.sasjs.html#getusername" class="tsd-kind-icon">get<wbr>User<wbr>Name</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="reflection-804.reflection-219.sasjs.html#login" class="tsd-kind-icon">log<wbr>In</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="reflection-804.reflection-219.sasjs.html#logout" class="tsd-kind-icon">log<wbr>Out</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="reflection-804.reflection-219.sasjs.html#movefolder" class="tsd-kind-icon">move<wbr>Folder</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="reflection-804.reflection-219.sasjs.html#refreshtokens" class="tsd-kind-icon">refresh<wbr>Tokens</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="reflection-804.reflection-219.sasjs.html#request" class="tsd-kind-icon">request</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="reflection-804.reflection-219.sasjs.html#setdebugstate" class="tsd-kind-icon">set<wbr>Debug<wbr>State</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="reflection-804.reflection-219.sasjs.html#setsasjsconfig" class="tsd-kind-icon">setSASjs<wbr>Config</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="reflection-804.reflection-219.sasjs.html#startcomputejob" class="tsd-kind-icon">start<wbr>Compute<wbr>Job</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="reflection-804.reflection-219.sasjs.html#uploadfile" class="tsd-kind-icon">upload<wbr>File</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="after-current">
|
|
<li class=" tsd-kind-class tsd-parent-kind-module root">
|
|
<a href="reflection-804.reflection-219.sessionmanager.html" class="tsd-kind-icon">Session<wbr>Manager</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<footer class="with-border-bottom">
|
|
</footer>
|
|
<div class="container tsd-generator">
|
|
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
</div>
|
|
<div class="overlay"></div>
|
|
<script src="../assets/js/main.js"></script>
|
|
</body>
|
|
</html> |