mirror of
https://github.com/sasjs/adapter.git
synced 2025-12-11 01:14:36 +00:00
1234 lines
185 KiB
HTML
1234 lines
185 KiB
HTML
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SASjs | @sasjs/adapter</title><meta name="description" content="Documentation for @sasjs/adapter"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
|
||
<div class="tsd-toolbar-contents container">
|
||
<div class="table-cell" id="tsd-search" data-base="..">
|
||
<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
|
||
<div class="field">
|
||
<div id="tsd-toolbar-links"></div></div>
|
||
<ul class="results">
|
||
<li class="state loading">Preparing search index...</li>
|
||
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@sasjs/adapter</a></div>
|
||
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
|
||
<div class="container container-main">
|
||
<div class="col-8 col-content">
|
||
<div class="tsd-page-title">
|
||
<ul class="tsd-breadcrumb">
|
||
<li><a href="../modules.html">@sasjs/adapter</a></li>
|
||
<li><a href="../modules/SASjs.html">SASjs</a></li>
|
||
<li><a href="SASjs.SASjs.html">SASjs</a></li></ul>
|
||
<h1>Class SASjs</h1></div>
|
||
<section class="tsd-panel tsd-comment">
|
||
<div class="tsd-comment tsd-typography"><p>SASjs is a JavaScript adapter for SAS.</p>
|
||
</div></section>
|
||
<section class="tsd-panel tsd-hierarchy">
|
||
<h4>Hierarchy</h4>
|
||
<ul class="tsd-hierarchy">
|
||
<li><span class="target">SASjs</span></li></ul></section><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L67">SASjs.ts:67</a></li></ul></aside>
|
||
<section class="tsd-panel-group tsd-index-group">
|
||
<section class="tsd-panel tsd-index-panel">
|
||
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
||
<h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex=0><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></svg> Index</h5></summary>
|
||
<div class="tsd-accordion-details">
|
||
<section class="tsd-index-section">
|
||
<h3 class="tsd-index-heading">Constructors</h3>
|
||
<div class="tsd-index-list"><a href="SASjs.SASjs.html#constructor" class="tsd-index-link tsd-kind-constructor tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-512-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-512-text"></path></svg><span>constructor</span></a>
|
||
</div></section>
|
||
<section class="tsd-index-section">
|
||
<h3 class="tsd-index-heading">Methods</h3>
|
||
<div class="tsd-index-list"><a href="SASjs.SASjs.html#Tables" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-2048-path"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)" id="icon-2048-text"></path></svg><span>Tables</span></a>
|
||
<a href="SASjs.SASjs.html#checkSession" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>check<wbr/>Session</span></a>
|
||
<a href="SASjs.SASjs.html#clearSasRequests" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>clear<wbr/>Sas<wbr/>Requests</span></a>
|
||
<a href="SASjs.SASjs.html#createComputeContext" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>create<wbr/>Compute<wbr/>Context</span></a>
|
||
<a href="SASjs.SASjs.html#createFile" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>create<wbr/>File</span></a>
|
||
<a href="SASjs.SASjs.html#createFolder" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>create<wbr/>Folder</span></a>
|
||
<a href="SASjs.SASjs.html#createJobDefinition" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>create<wbr/>Job<wbr/>Definition</span></a>
|
||
<a href="SASjs.SASjs.html#createLauncherContext" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>create<wbr/>Launcher<wbr/>Context</span></a>
|
||
<a href="SASjs.SASjs.html#createSession" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>create<wbr/>Session</span></a>
|
||
<a href="SASjs.SASjs.html#deleteClient" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>delete<wbr/>Client</span></a>
|
||
<a href="SASjs.SASjs.html#deleteComputeContext" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>delete<wbr/>Compute<wbr/>Context</span></a>
|
||
<a href="SASjs.SASjs.html#deleteFolder" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>delete<wbr/>Folder</span></a>
|
||
<a href="SASjs.SASjs.html#deployServicePack" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>deploy<wbr/>Service<wbr/>Pack</span></a>
|
||
<a href="SASjs.SASjs.html#disableVerboseMode" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>disable<wbr/>Verbose<wbr/>Mode</span></a>
|
||
<a href="SASjs.SASjs.html#editComputeContext" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>edit<wbr/>Compute<wbr/>Context</span></a>
|
||
<a href="SASjs.SASjs.html#enableVerboseMode" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>enable<wbr/>Verbose<wbr/>Mode</span></a>
|
||
<a href="SASjs.SASjs.html#executeJob" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>execute<wbr/>Job</span></a>
|
||
<a href="SASjs.SASjs.html#executeScript" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>execute<wbr/>Script</span></a>
|
||
<a href="SASjs.SASjs.html#fetchLogFileContent" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>fetch<wbr/>Log<wbr/>File<wbr/>Content</span></a>
|
||
<a href="SASjs.SASjs.html#getAccessToken" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Access<wbr/>Token</span></a>
|
||
<a href="SASjs.SASjs.html#getAuthCode" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Auth<wbr/>Code</span></a>
|
||
<a href="SASjs.SASjs.html#getComputeContextById" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Compute<wbr/>Context<wbr/>By<wbr/>Id</span></a>
|
||
<a href="SASjs.SASjs.html#getComputeContextByName" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Compute<wbr/>Context<wbr/>By<wbr/>Name</span></a>
|
||
<a href="SASjs.SASjs.html#getComputeContexts" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Compute<wbr/>Contexts</span></a>
|
||
<a href="SASjs.SASjs.html#getCsrfToken" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Csrf<wbr/>Token</span></a>
|
||
<a href="SASjs.SASjs.html#getDefaultComputeContexts" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Default<wbr/>Compute<wbr/>Contexts</span></a>
|
||
<a href="SASjs.SASjs.html#getExecutableContexts" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Executable<wbr/>Contexts</span></a>
|
||
<a href="SASjs.SASjs.html#getFileContent" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>File<wbr/>Content</span></a>
|
||
<a href="SASjs.SASjs.html#getFolder" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Folder</span></a>
|
||
<a href="SASjs.SASjs.html#getLauncherContexts" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Launcher<wbr/>Contexts</span></a>
|
||
<a href="SASjs.SASjs.html#getSasRequests" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Sas<wbr/>Requests</span></a>
|
||
<a href="SASjs.SASjs.html#getSasjsConfig" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Sasjs<wbr/>Config</span></a>
|
||
<a href="SASjs.SASjs.html#getUserName" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>User<wbr/>Name</span></a>
|
||
<a href="SASjs.SASjs.html#listFolder" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>list<wbr/>Folder</span></a>
|
||
<a href="SASjs.SASjs.html#logIn" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>log<wbr/>In</span></a>
|
||
<a href="SASjs.SASjs.html#logOut" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>log<wbr/>Out</span></a>
|
||
<a href="SASjs.SASjs.html#moveFolder" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>move<wbr/>Folder</span></a>
|
||
<a href="SASjs.SASjs.html#refreshTokens" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>refresh<wbr/>Tokens</span></a>
|
||
<a href="SASjs.SASjs.html#request" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>request</span></a>
|
||
<a href="SASjs.SASjs.html#setDebugState" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>set<wbr/>Debug<wbr/>State</span></a>
|
||
<a href="SASjs.SASjs.html#setSASjsConfig" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>setSASjs<wbr/>Config</span></a>
|
||
<a href="SASjs.SASjs.html#setVerboseMode" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>set<wbr/>Verbose<wbr/>Mode</span></a>
|
||
<a href="SASjs.SASjs.html#startComputeJob" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>start<wbr/>Compute<wbr/>Job</span></a>
|
||
<a href="SASjs.SASjs.html#updateFileContent" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>update<wbr/>File<wbr/>Content</span></a>
|
||
<a href="SASjs.SASjs.html#uploadFile" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>upload<wbr/>File</span></a>
|
||
</div></section></div></details></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 id="constructor" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="constructor.new_SASjs">new SASjs<span class="tsd-signature-symbol">(</span>config<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="types.SASjsConfig.html" class="tsd-signature-type" data-tsd-kind="Class">SASjsConfig</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SASjs.SASjs.html" class="tsd-signature-type" data-tsd-kind="Class">SASjs</a><a href="#constructor.new_SASjs" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> config: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="types.SASjsConfig.html" class="tsd-signature-type" data-tsd-kind="Class">SASjsConfig</a><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SASjs.SASjs.html" class="tsd-signature-type" data-tsd-kind="Class">SASjs</a></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L82">SASjs.ts:82</a></li></ul></aside></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 id="Tables" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>Tables</span><a href="#Tables" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="Tables.Tables-1">Tables<span class="tsd-signature-symbol">(</span>table<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span>, macroName<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><a href="types.Tables.html" class="tsd-signature-type" data-tsd-kind="Class">Tables</a><a href="#Tables.Tables-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Create a tables class containing one or more tables to be sent to
|
||
SAS.</p>
|
||
|
||
<h3>Returns</h3><p>Tables class</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>table: <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>initial table data</p>
|
||
</div></li>
|
||
<li>
|
||
<h5>macroName: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>macro name</p>
|
||
</div></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="types.Tables.html" class="tsd-signature-type" data-tsd-kind="Class">Tables</a></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L1252">SASjs.ts:1252</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="checkSession" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>check<wbr/>Session</span><a href="#checkSession" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="checkSession.checkSession-1">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><a href="../interfaces/types.LoginResultInternal.html" class="tsd-signature-type" data-tsd-kind="Interface">LoginResultInternal</a><span class="tsd-signature-symbol">></span><a href="#checkSession.checkSession-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Checks whether a session is active, or login is required.</p>
|
||
|
||
<h3>Returns</h3><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>
|
||
</div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types.LoginResultInternal.html" class="tsd-signature-type" data-tsd-kind="Interface">LoginResultInternal</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L662">SASjs.ts:662</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="clearSasRequests" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>clear<wbr/>Sas<wbr/>Requests</span><a href="#clearSasRequests" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="clearSasRequests.clearSasRequests-1">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><a href="#clearSasRequests.clearSasRequests-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L1020">SASjs.ts:1020</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createComputeContext" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>create<wbr/>Compute<wbr/>Context</span><a href="#createComputeContext" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="createComputeContext.createComputeContext-1">create<wbr/>Compute<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>, authorisedUsers<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" data-tsd-kind="Interface">Context</a><span class="tsd-signature-symbol">></span><a href="#createComputeContext.createComputeContext-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Creates a compute context on the given server.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>contextName: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><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"><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"><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"><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"><p>an access token for an authorised user.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> authorisedUsers: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>an optional list of authorised user IDs.</p>
|
||
</div></li></ul></div>
|
||
<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" data-tsd-kind="Interface">Context</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L230">SASjs.ts:230</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createFile" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>create<wbr/>File</span><a href="#createFile" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="createFile.createFile-1">create<wbr/>File<span class="tsd-signature-symbol">(</span>fileName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, content<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</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">string</span>, accessToken<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, sasApiClient<span class="tsd-signature-symbol">?: </span><a href="SASViyaApiClient.SASViyaApiClient.html" class="tsd-signature-type" data-tsd-kind="Class">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><a href="../interfaces/types.File.html" class="tsd-signature-type" data-tsd-kind="Interface">File</a><span class="tsd-signature-symbol">></span><a href="#createFile.createFile-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Creates a file in the logical SAS folder tree</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>fileName: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>name of the file to be created.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5>content: <span class="tsd-signature-type">Buffer</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>content of the file to be created.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5>parentFolderPath: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>the full path (eg <code>/Public/example/myFolder</code>) of the parent folder.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> parentFolderUri: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>the URI of the parent folder.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> accessToken: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>the access token to authorizing the request.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> sasApiClient: <a href="SASViyaApiClient.SASViyaApiClient.html" class="tsd-signature-type" data-tsd-kind="Class">SASViyaApiClient</a></h5>
|
||
<div class="tsd-comment tsd-typography"><p>a client for interfacing with SAS API.</p>
|
||
</div></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types.File.html" class="tsd-signature-type" data-tsd-kind="Interface">File</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L390">SASjs.ts:390</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createFolder" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>create<wbr/>Folder</span><a href="#createFolder" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="createFolder.createFolder-1">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">string</span>, accessToken<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, sasApiClient<span class="tsd-signature-symbol">?: </span><a href="SASViyaApiClient.SASViyaApiClient.html" class="tsd-signature-type" data-tsd-kind="Class">SASViyaApiClient</a>, 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><a href="../interfaces/types.Folder.html" class="tsd-signature-type" data-tsd-kind="Interface">Folder</a><span class="tsd-signature-symbol">></span><a href="#createFolder.createFolder-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Creates a folder in the logical SAS folder tree</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>folderName: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><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"><p>the full path (eg <code>/Public/example/myFolder</code>) of the parent folder.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> parentFolderUri: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>the URI of the parent folder.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> accessToken: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>the access token to authorizing the request.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> sasApiClient: <a href="SASViyaApiClient.SASViyaApiClient.html" class="tsd-signature-type" data-tsd-kind="Class">SASViyaApiClient</a></h5>
|
||
<div class="tsd-comment tsd-typography"><p>a client for interfacing with SAS API.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> isForced: <span class="tsd-signature-type">boolean</span></h5>
|
||
<div class="tsd-comment tsd-typography"><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></div>
|
||
<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" data-tsd-kind="Interface">Folder</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L354">SASjs.ts:354</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createJobDefinition" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>create<wbr/>Job<wbr/>Definition</span><a href="#createJobDefinition" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="createJobDefinition.createJobDefinition-1">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">string</span>, parentFolderUri<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>, sasApiClient<span class="tsd-signature-symbol">?: </span><a href="SASViyaApiClient.SASViyaApiClient.html" class="tsd-signature-type" data-tsd-kind="Class">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-symbol">{ </span><br/><span> </span>etag<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>result<span class="tsd-signature-symbol">: </span><a href="../interfaces/types.Job.html" class="tsd-signature-type" data-tsd-kind="Interface">Job</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span><a href="#createJobDefinition.createJobDefinition-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<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><code class="tsd-tag ts-flagOptional">Optional</code> parentFolderPath: <span class="tsd-signature-type">string</span></h5></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> parentFolderUri: <span class="tsd-signature-type">string</span></h5></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> accessToken: <span class="tsd-signature-type">string</span></h5></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> sasApiClient: <a href="SASViyaApiClient.SASViyaApiClient.html" class="tsd-signature-type" data-tsd-kind="Class">SASViyaApiClient</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span>etag<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>result<span class="tsd-signature-symbol">: </span><a href="../interfaces/types.Job.html" class="tsd-signature-type" data-tsd-kind="Interface">Job</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L528">SASjs.ts:528</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createLauncherContext" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>create<wbr/>Launcher<wbr/>Context</span><a href="#createLauncherContext" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="createLauncherContext.createLauncherContext-1">create<wbr/>Launcher<wbr/>Context<span class="tsd-signature-symbol">(</span>contextName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, description<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, launchType<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.Context.html" class="tsd-signature-type" data-tsd-kind="Interface">Context</a><span class="tsd-signature-symbol">></span><a href="#createLauncherContext.createLauncherContext-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Creates a launcher context on the given server.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>contextName: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>the name of the context to be created.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5>description: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>the description of the context to be created.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5>launchType: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>launch type of the context to be created.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5>accessToken: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>an access token for an authorised user.</p>
|
||
</div></li></ul></div>
|
||
<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" data-tsd-kind="Interface">Context</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L257">SASjs.ts:257</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createSession" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>create<wbr/>Session</span><a href="#createSession" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="createSession.createSession-1">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" data-tsd-kind="Interface">Session</a><span class="tsd-signature-symbol">></span><a href="#createSession.createSession-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<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></div>
|
||
<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" data-tsd-kind="Interface">Session</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L339">SASjs.ts:339</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deleteClient" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>delete<wbr/>Client</span><a href="#deleteClient" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="deleteClient.deleteClient-1">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">unknown</span><span class="tsd-signature-symbol">></span><a href="#deleteClient.deleteClient-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<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></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><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L613">SASjs.ts:613</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deleteComputeContext" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>delete<wbr/>Compute<wbr/>Context</span><a href="#deleteComputeContext" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="deleteComputeContext.deleteComputeContext-1">delete<wbr/>Compute<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">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-symbol">{ </span><br/><span> </span>etag<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>result<span class="tsd-signature-symbol">: </span><a href="../interfaces/types.Context.html" class="tsd-signature-type" data-tsd-kind="Interface">Context</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span><a href="#deleteComputeContext.deleteComputeContext-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Deletes a compute context on the given server.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>contextName: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>the name of the context to be deleted.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> accessToken: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>an access token for an authorised user.</p>
|
||
</div></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span>etag<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>result<span class="tsd-signature-symbol">: </span><a href="../interfaces/types.Context.html" class="tsd-signature-type" data-tsd-kind="Interface">Context</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L298">SASjs.ts:298</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deleteFolder" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>delete<wbr/>Folder</span><a href="#deleteFolder" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="deleteFolder.deleteFolder-1">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" data-tsd-kind="Interface">Folder</a><span class="tsd-signature-symbol">></span><a href="#deleteFolder.deleteFolder-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><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 class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>folderPath: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><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"><p>an access token for authorizing the request.</p>
|
||
</div></li></ul></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">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/types.Folder.html" class="tsd-signature-type" data-tsd-kind="Interface">Folder</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L475">SASjs.ts:475</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deployServicePack" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>deploy<wbr/>Service<wbr/>Pack</span><a href="#deployServicePack" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="deployServicePack.deployServicePack-1">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">string</span>, serverUrl<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>, 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><a href="#deployServicePack.deployServicePack-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Creates the folders and services at the given location <code>appLoc</code> on the given server <code>serverUrl</code>.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>serviceJson: <span class="tsd-signature-type">any</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>the JSON specifying the folders and services to be created.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> appLoc: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><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><code class="tsd-tag ts-flagOptional">Optional</code> serverUrl: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>the server on which to deploy the folders and services.
|
||
If not provided, is taken from SASjsConfig.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> accessToken: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>an optional access token to be passed in when
|
||
using this function from the command line.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5>isForced: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>flag that indicates if target folder already exists, it and all subfolders have to be deleted.</p>
|
||
</div></li></ul></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">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L851">SASjs.ts:851</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="disableVerboseMode" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>disable<wbr/>Verbose<wbr/>Mode</span><a href="#disableVerboseMode" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="disableVerboseMode.disableVerboseMode-1">disable<wbr/>Verbose<wbr/>Mode<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><a href="#disableVerboseMode.disableVerboseMode-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Turns off verbose mode to log every HTTP response.</p>
|
||
</div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L1233">SASjs.ts:1233</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="editComputeContext" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>edit<wbr/>Compute<wbr/>Context</span><a href="#editComputeContext" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="editComputeContext.editComputeContext-1">edit<wbr/>Compute<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" data-tsd-kind="Interface">EditContextInput</a>, 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-symbol">{ </span><br/><span> </span>etag<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>result<span class="tsd-signature-symbol">: </span><a href="../interfaces/types.Context.html" class="tsd-signature-type" data-tsd-kind="Interface">Context</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span><a href="#editComputeContext.editComputeContext-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Updates a compute context on the given server.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>contextName: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><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" data-tsd-kind="Interface">EditContextInput</a></h5>
|
||
<div class="tsd-comment tsd-typography"><p>an object with the properties to be updated.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> accessToken: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>an access token for an authorised user.</p>
|
||
</div></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span>etag<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>result<span class="tsd-signature-symbol">: </span><a href="../interfaces/types.Context.html" class="tsd-signature-type" data-tsd-kind="Interface">Context</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L279">SASjs.ts:279</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="enableVerboseMode" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>enable<wbr/>Verbose<wbr/>Mode</span><a href="#enableVerboseMode" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="enableVerboseMode.enableVerboseMode-1">enable<wbr/>Verbose<wbr/>Mode<span class="tsd-signature-symbol">(</span>successCallBack<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</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><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</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><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span>, errorCallBack<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</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><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#enableVerboseMode.enableVerboseMode-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Enables verbose mode that will log a summary of every HTTP response.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> successCallBack: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</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><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</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><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>function that should be triggered on every HTTP response with the status 2**.</p>
|
||
</div>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-kind-type-literal">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</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><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</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><span class="tsd-signature-symbol">></span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>response: <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</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><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</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><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> errorCallBack: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</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><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</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></h5>
|
||
<div class="tsd-comment tsd-typography"><p>function that should be triggered on every HTTP response with the status different from 2**.</p>
|
||
</div>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-kind-type-literal">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</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><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>response: <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L1223">SASjs.ts:1223</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="executeJob" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>execute<wbr/>Job</span><a href="#executeJob" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="executeJob.executeJob-1">execute<wbr/>Job<span class="tsd-signature-symbol">(</span>query<span class="tsd-signature-symbol">: </span><a href="../interfaces/types.ExecutionQuery.html" class="tsd-signature-type" data-tsd-kind="Interface">ExecutionQuery</a>, appLoc<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, authConfig<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AuthConfig</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-symbol">{ </span><br/><span> </span>log<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span>result<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span><a href="#executeJob.executeJob-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Executes job on SASJS server.</p>
|
||
|
||
<h3>Returns</h3><p>a promise that resolves into job execution result and log.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>query: <a href="../interfaces/types.ExecutionQuery.html" class="tsd-signature-type" data-tsd-kind="Interface">ExecutionQuery</a></h5>
|
||
<div class="tsd-comment tsd-typography"><p>an object containing job path and debug level.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5>appLoc: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>an application path.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> authConfig: <span class="tsd-signature-type">AuthConfig</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>an object for authentication.</p>
|
||
</div></li></ul></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">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>log<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span>result<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L172">SASjs.ts:172</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="executeScript" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>execute<wbr/>Script</span><a href="#executeScript" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="executeScript.executeScript-1">execute<wbr/>Script<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ExecuteScriptParams</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><a href="#executeScript.executeScript-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Executes code on a SAS server.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>__namedParameters: <span class="tsd-signature-type">ExecuteScriptParams</span></h5></li></ul></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">any</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L105">SASjs.ts:105</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="fetchLogFileContent" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>fetch<wbr/>Log<wbr/>File<wbr/>Content</span><a href="#fetchLogFileContent" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="fetchLogFileContent.fetchLogFileContent-1">fetch<wbr/>Log<wbr/>File<wbr/>Content<span class="tsd-signature-symbol">(</span>logUrl<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">string</span><span class="tsd-signature-symbol">></span><a href="#fetchLogFileContent.fetchLogFileContent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Fetches content of the log file</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>logUrl: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>url of the log file.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> accessToken: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>an access token for an authorised user.</p>
|
||
</div></li></ul></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">string</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L986">SASjs.ts:986</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getAccessToken" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>get<wbr/>Access<wbr/>Token</span><a href="#getAccessToken" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="getAccessToken.getAccessToken-1">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">SasAuthResponse</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/SASjsApiClient.SASjsAuthResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SASjsAuthResponse</a><span class="tsd-signature-symbol">></span><a href="#getAccessToken.getAccessToken-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Exchanges the auth code for an access token for the given client.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>clientId: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>the client ID to authenticate with.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5>clientSecret: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>the client secret to authenticate with.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5>authCode: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>the auth code received from the server.</p>
|
||
</div></li></ul></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">SasAuthResponse</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/SASjsApiClient.SASjsAuthResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SASjsAuthResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L567">SASjs.ts:567</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getAuthCode" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>get<wbr/>Auth<wbr/>Code</span><a href="#getAuthCode" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="getAuthCode.getAuthCode-1">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><a href="#getAuthCode.getAuthCode-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>clientId: <span class="tsd-signature-type">string</span></h5></li></ul></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">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L555">SASjs.ts:555</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getComputeContextById" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>get<wbr/>Compute<wbr/>Context<wbr/>By<wbr/>Id</span><a href="#getComputeContextById" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="getComputeContextById.getComputeContextById-1">get<wbr/>Compute<wbr/>Context<wbr/>By<wbr/>Id<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">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" data-tsd-kind="Interface">ContextAllAttributes</a><span class="tsd-signature-symbol">></span><a href="#getComputeContextById.getComputeContextById-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Returns a JSON representation of a compute context.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>contextId: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>an id of the context to return.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> accessToken: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>an access token for an authorised user.</p>
|
||
</div></li></ul></div>
|
||
<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" data-tsd-kind="Interface">ContextAllAttributes</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L330">SASjs.ts:330</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getComputeContextByName" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>get<wbr/>Compute<wbr/>Context<wbr/>By<wbr/>Name</span><a href="#getComputeContextByName" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="getComputeContextByName.getComputeContextByName-1">get<wbr/>Compute<wbr/>Context<wbr/>By<wbr/>Name<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.Context.html" class="tsd-signature-type" data-tsd-kind="Interface">Context</a><span class="tsd-signature-symbol">></span><a href="#getComputeContextByName.getComputeContextByName-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Returns a JSON representation of a compute context.
|
||
@example: { "createdBy": "admin", "links": [...], "id": "ID", "version": 2, "name": "context1" }</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>contextName: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>the name of the context to return.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> accessToken: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>an access token for an authorised user.</p>
|
||
</div></li></ul></div>
|
||
<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" data-tsd-kind="Interface">Context</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L313">SASjs.ts:313</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getComputeContexts" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>get<wbr/>Compute<wbr/>Contexts</span><a href="#getComputeContexts" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="getComputeContexts.getComputeContexts-1">get<wbr/>Compute<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-symbol">{ </span><br/><span> </span>attributes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">; </span><br/><span> </span>createdBy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span>version<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#getComputeContexts.getComputeContexts-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Gets compute contexts.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>accessToken: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>an access token for an authorised user.</p>
|
||
</div></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span>attributes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">; </span><br/><span> </span>createdBy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span>version<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L186">SASjs.ts:186</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getCsrfToken" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>get<wbr/>Csrf<wbr/>Token</span><a href="#getCsrfToken" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="getCsrfToken.getCsrfToken-1">get<wbr/>Csrf<wbr/>Token<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"general"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"file"</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><a href="../interfaces/types.CsrfToken.html" class="tsd-signature-type" data-tsd-kind="Interface">CsrfToken</a><a href="#getCsrfToken.getCsrfToken-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>type: <span class="tsd-signature-type">"general"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"file"</span><span class="tsd-signature-symbol"> = 'general'</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/types.CsrfToken.html" class="tsd-signature-type" data-tsd-kind="Interface">CsrfToken</a></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L91">SASjs.ts:91</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getDefaultComputeContexts" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>get<wbr/>Default<wbr/>Compute<wbr/>Contexts</span><a href="#getDefaultComputeContexts" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="getDefaultComputeContexts.getDefaultComputeContexts-1">get<wbr/>Default<wbr/>Compute<wbr/>Contexts<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><span class="tsd-signature-symbol">[]</span><a href="#getDefaultComputeContexts.getDefaultComputeContexts-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Gets default(system) launcher contexts.</p>
|
||
</div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L205">SASjs.ts:205</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getExecutableContexts" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>get<wbr/>Executable<wbr/>Contexts</span><a href="#getExecutableContexts" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="getExecutableContexts.getExecutableContexts-1">get<wbr/>Executable<wbr/>Contexts<span class="tsd-signature-symbol">(</span>authConfig<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AuthConfig</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><a href="#getExecutableContexts.getExecutableContexts-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Gets executable compute contexts.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>authConfig: <span class="tsd-signature-type">AuthConfig</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>an access token, refresh token, client and secret for an authorised user.</p>
|
||
</div></li></ul></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">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L215">SASjs.ts:215</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getFileContent" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>get<wbr/>File<wbr/>Content</span><a href="#getFileContent" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="getFileContent.getFileContent-1">get<wbr/>File<wbr/>Content<span class="tsd-signature-symbol">(</span>folderPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, fileName<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">string</span><span class="tsd-signature-symbol">></span><a href="#getFileContent.getFileContent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Fetches the file content for a file in the specified folder.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>folderPath: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>the full path to the folder containing the file. eg: /Public/folder1/folder2</p>
|
||
</div></li>
|
||
<li>
|
||
<h5>fileName: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>the name of the file in the <code>folderPath</code></p>
|
||
</div></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> accessToken: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>an access token for authorizing the request</p>
|
||
</div></li></ul></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">string</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L422">SASjs.ts:422</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getFolder" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>get<wbr/>Folder</span><a href="#getFolder" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="getFolder.getFolder-1">get<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">unknown</span><span class="tsd-signature-symbol">></span><a href="#getFolder.getFolder-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Fetches a folder from the SAS file system.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>folderPath: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>path of the folder to be fetched.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> accessToken: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>the access token to authorize the request.</p>
|
||
</div></li></ul></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><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L465">SASjs.ts:465</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getLauncherContexts" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>get<wbr/>Launcher<wbr/>Contexts</span><a href="#getLauncherContexts" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="getLauncherContexts.getLauncherContexts-1">get<wbr/>Launcher<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-symbol">{ </span><br/><span> </span>attributes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">; </span><br/><span> </span>createdBy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span>version<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#getLauncherContexts.getLauncherContexts-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Gets launcher contexts.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>accessToken: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>an access token for an authorised user.</p>
|
||
</div></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span>attributes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">; </span><br/><span> </span>createdBy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span>version<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L196">SASjs.ts:196</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getSasRequests" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>get<wbr/>Sas<wbr/>Requests</span><a href="#getSasRequests" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="getSasRequests.getSasRequests-1">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" data-tsd-kind="Interface">SASjsRequest</a><span class="tsd-signature-symbol">[]</span><a href="#getSasRequests.getSasRequests-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>this method returns an array of SASjsRequest</p>
|
||
|
||
<h3>Returns</h3><p>SASjsRequest[]</p>
|
||
</div>
|
||
<h4 class="tsd-returns-title">Returns <a href="../interfaces/types.SASjsRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">SASjsRequest</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L1014">SASjs.ts:1014</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getSasjsConfig" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>get<wbr/>Sasjs<wbr/>Config</span><a href="#getSasjsConfig" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="getSasjsConfig.getSasjsConfig-1">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" data-tsd-kind="Class">SASjsConfig</a><a href="#getSasjsConfig.getSasjsConfig-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Returns the current SASjs configuration.</p>
|
||
</div>
|
||
<h4 class="tsd-returns-title">Returns <a href="types.SASjsConfig.html" class="tsd-signature-type" data-tsd-kind="Class">SASjsConfig</a></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L623">SASjs.ts:623</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getUserName" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>get<wbr/>User<wbr/>Name</span><a href="#getUserName" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="getUserName.getUserName-1">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><a href="#getUserName.getUserName-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Returns the username of the user currently logged in.</p>
|
||
</div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L631">SASjs.ts:631</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="listFolder" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>list<wbr/>Folder</span><a href="#listFolder" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="listFolder.listFolder-1">list<wbr/>Folder<span class="tsd-signature-symbol">(</span>sourceFolder<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>, limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, returnDetails<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">undefined</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><a href="#listFolder.listFolder-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Lists children folders for given Viya folder.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>sourceFolder: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>the full path (eg <code>/Public/example/myFolder</code>) or URI of the source folder listed. Providing URI instead of path will save one extra request.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> accessToken: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>an access token for authorizing the request.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> limit: <span class="tsd-signature-type">number</span></h5></li>
|
||
<li>
|
||
<h5>returnDetails: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>when set to true, the function will return an array of objects with member details, otherwise it will return an array of member names.</p>
|
||
</div></li></ul></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">undefined</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><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L487">SASjs.ts:487</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="logIn" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>log<wbr/>In</span><a href="#logIn" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="logIn.logIn-1">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>, clientId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/types.LoginOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">LoginOptions</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><a href="../interfaces/types.LoginResult.html" class="tsd-signature-type" data-tsd-kind="Interface">LoginResult</a><span class="tsd-signature-symbol">></span><a href="#logIn.logIn-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Logs into the SAS server with the supplied credentials.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> username: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>a string representing the username.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> password: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>a string representing the password.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> clientId: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>a string representing the client ID.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5>options: <a href="../interfaces/types.LoginOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">LoginOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/types.LoginResult.html" class="tsd-signature-type" data-tsd-kind="Interface">LoginResult</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L672">SASjs.ts:672</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="logOut" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>log<wbr/>Out</span><a href="#logOut" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="logOut.logOut-1">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">boolean</span><span class="tsd-signature-symbol">></span><a href="#logOut.logOut-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Logs out of the configured SAS server.</p>
|
||
</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">boolean</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L699">SASjs.ts:699</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="moveFolder" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>move<wbr/>Folder</span><a href="#moveFolder" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="moveFolder.moveFolder-1">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" data-tsd-kind="Interface">Folder</a><span class="tsd-signature-symbol">></span><a href="#moveFolder.moveFolder-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Moves folder to a new location. The folder may be renamed at the same time.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>sourceFolder: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><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"><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"><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"><p>an access token for authorizing the request.</p>
|
||
</div></li></ul></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">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/types.Folder.html" class="tsd-signature-type" data-tsd-kind="Interface">Folder</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L512">SASjs.ts:512</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="refreshTokens" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>refresh<wbr/>Tokens</span><a href="#refreshTokens" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="refreshTokens.refreshTokens-1">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">SasAuthResponse</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/SASjsApiClient.SASjsAuthResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SASjsAuthResponse</a><span class="tsd-signature-symbol">></span><a href="#refreshTokens.refreshTokens-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Exchanges the refresh token for an access token for the given client.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>clientId: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>the client ID to authenticate with.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5>clientSecret: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>the client secret to authenticate with.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5>refreshToken: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>the refresh token received from the server.</p>
|
||
</div></li></ul></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">SasAuthResponse</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/SASjsApiClient.SASjsAuthResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">SASjsAuthResponse</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L593">SASjs.ts:593</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="request" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="request.request-1">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">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>[key: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span>, config<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>[key: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span>, loginRequiredCallback<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span>, authConfig<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AuthConfig</span>, extraResponseAttributes<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ExtraResponseAttributes</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><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#request.request-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Makes a request to program specified in <code>SASjob</code> (could be a Viya Job, a
|
||
SAS 9 Stored Process, or a SASjs Server Stored Program). 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 class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>sasJob: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><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">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>[key: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>a JSON object containing one or more tables to be sent to
|
||
SAS. For an example of the table structure, see the project README. This
|
||
value can be <code>null</code> if no inputs are required.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5>config: <span class="tsd-signature-symbol">{ </span><br/><span> </span>[key: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
||
<div class="tsd-comment tsd-typography"><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>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-index-signature">
|
||
<h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></h5></li></ul></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> loginRequiredCallback: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>a function that is called if the
|
||
user is not logged in (eg to display a login form). The request will be
|
||
resubmitted after successful login.
|
||
When using a <code>loginRequiredCallback</code>, the call to the request will look, for example, like so:
|
||
<code>await request(sasJobPath, data, config, () => setIsLoggedIn(false))</code>
|
||
If you are not passing in any data and configuration, it will look like so:
|
||
<code>await request(sasJobPath, {}, {}, () => setIsLoggedIn(false))</code></p>
|
||
</div>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-kind-type-literal">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> authConfig: <span class="tsd-signature-type">AuthConfig</span></h5></li>
|
||
<li>
|
||
<h5>extraResponseAttributes: <span class="tsd-signature-type">ExtraResponseAttributes</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>a array of predefined values that are used
|
||
to provide extra attributes (same names as those values) to be added in response
|
||
Supported values are declared in ExtraResponseAttributes type.</p>
|
||
</div></li></ul></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">any</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L765">SASjs.ts:765</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setDebugState" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>set<wbr/>Debug<wbr/>State</span><a href="#setDebugState" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="setDebugState.setDebugState-1">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><a href="#setDebugState.setDebugState-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Sets the debug state. Turning this on will enable additional logging in the adapter.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>value: <span class="tsd-signature-type">boolean</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>boolean indicating debug state (on/off).</p>
|
||
</div></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L651">SASjs.ts:651</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setSASjsConfig" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>setSASjs<wbr/>Config</span><a href="#setSASjsConfig" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="setSASjsConfig.setSASjsConfig-1">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" data-tsd-kind="Class">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><a href="#setSASjsConfig.setSASjsConfig-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Sets the SASjs configuration.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>config: <a href="types.SASjsConfig.html" class="tsd-signature-type" data-tsd-kind="Class">SASjsConfig</a></h5>
|
||
<div class="tsd-comment tsd-typography"><p>SASjs configuration.</p>
|
||
</div></li></ul></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">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L639">SASjs.ts:639</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setVerboseMode" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>set<wbr/>Verbose<wbr/>Mode</span><a href="#setVerboseMode" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="setVerboseMode.setVerboseMode-1">set<wbr/>Verbose<wbr/>Mode<span class="tsd-signature-symbol">(</span>verboseMode<span class="tsd-signature-symbol">: </span><a href="../types/types.VerboseMode.html" class="tsd-signature-type" data-tsd-kind="Type alias">VerboseMode</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setVerboseMode.setVerboseMode-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Sets verbose mode.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>verboseMode: <a href="../types/types.VerboseMode.html" class="tsd-signature-type" data-tsd-kind="Type alias">VerboseMode</a></h5>
|
||
<div class="tsd-comment tsd-typography"><p>value of the verbose mode, can be true, false or bleached(without extra colors).</p>
|
||
</div></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L1241">SASjs.ts:1241</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="startComputeJob" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>start<wbr/>Compute<wbr/>Job</span><a href="#startComputeJob" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="startComputeJob.startComputeJob-1">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>, authConfig<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AuthConfig</span>, waitForResult<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, pollOptions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/types.PollOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">PollOptions</a>, printPid<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, variables<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">MacroVar</span>, verboseMode<span class="tsd-signature-symbol">?: </span><a href="../types/types.VerboseMode.html" class="tsd-signature-type" data-tsd-kind="Type alias">VerboseMode</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><a href="#startComputeJob.startComputeJob-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Kicks off execution of the given job via the compute API.</p>
|
||
|
||
<h3>Returns</h3><p>an object representing the compute session created for the given job.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>sasJob: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><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"><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>config: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
||
<div class="tsd-comment tsd-typography"><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><code class="tsd-tag ts-flagOptional">Optional</code> authConfig: <span class="tsd-signature-type">AuthConfig</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>a valid client, secret, refresh and access tokens that are authorised to execute compute jobs.
|
||
The access token is not required when the user is authenticated via the browser.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> waitForResult: <span class="tsd-signature-type">boolean</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>a boolean that indicates whether the function needs to wait for execution to complete.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> pollOptions: <a href="../interfaces/types.PollOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">PollOptions</a></h5>
|
||
<div class="tsd-comment tsd-typography"><p>an object that represents poll interval(milliseconds) and maximum amount of attempts. Object example: { maxPollCount: 24 * 60 * 60, pollInterval: 1000 }. More information available at src/api/viya/pollJobState.ts.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5>printPid: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>a boolean that indicates whether the function should print (PID) of the started job.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> variables: <span class="tsd-signature-type">MacroVar</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>an object that represents macro variables.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> verboseMode: <a href="../types/types.VerboseMode.html" class="tsd-signature-type" data-tsd-kind="Type alias">VerboseMode</a></h5>
|
||
<div class="tsd-comment tsd-typography"><p>boolean or a string equal to 'bleached' to enable verbose mode (log every HTTP response).</p>
|
||
</div></li></ul></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">any</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L931">SASjs.ts:931</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="updateFileContent" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>update<wbr/>File<wbr/>Content</span><a href="#updateFileContent" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="updateFileContent.updateFileContent-1">update<wbr/>File<wbr/>Content<span class="tsd-signature-symbol">(</span>folderPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, fileName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, content<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">FileResource</span><span class="tsd-signature-symbol">></span><a href="#updateFileContent.updateFileContent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Updates the file content for a file in the specified folder.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>folderPath: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>the full path to the folder containing the file. eg: /Public/folder1/folder2</p>
|
||
</div></li>
|
||
<li>
|
||
<h5>fileName: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>the name of the file in the <code>folderPath</code></p>
|
||
</div></li>
|
||
<li>
|
||
<h5>content: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>the new content to be written to the file</p>
|
||
</div></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> accessToken: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>an access token for authorizing the request</p>
|
||
</div></li></ul></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">FileResource</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L444">SASjs.ts:444</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="uploadFile" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>upload<wbr/>File</span><a href="#uploadFile" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||
<li class="tsd-signature tsd-anchor-link" id="uploadFile.uploadFile-1">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" data-tsd-kind="Interface">UploadFile</a><span class="tsd-signature-symbol">[]</span>, params<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>[key: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span>, config<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>[key: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span>, loginRequiredCallback<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</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><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><a href="#uploadFile.uploadFile-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Uploads a file to the given service.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5>sasJob: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><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" data-tsd-kind="Interface">UploadFile</a><span class="tsd-signature-symbol">[]</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>array of files to be uploaded, including File object and file name.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5>params: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>[key: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>request URL parameters.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5>config: <span class="tsd-signature-symbol">{ </span><br/><span> </span>[key: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
||
<div class="tsd-comment tsd-typography"><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>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-index-signature">
|
||
<h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></h5></li></ul></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> loginRequiredCallback: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>a function that is called if the
|
||
user is not logged in (eg to display a login form). The request will be
|
||
resubmitted after successful login.</p>
|
||
</div>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-kind-type-literal">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></li></ul></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><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/87b60a4/src/SASjs.ts#L717">SASjs.ts:717</a></li></ul></aside></li></ul></section></section></div>
|
||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||
<div class="tsd-navigation settings">
|
||
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
||
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Settings</h3></summary>
|
||
<div class="tsd-accordion-details">
|
||
<div class="tsd-filter-visibility">
|
||
<h4 class="uppercase">Member Visibility</h4><form>
|
||
<ul id="tsd-filter-options">
|
||
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
|
||
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></form></div>
|
||
<div class="tsd-theme-toggle">
|
||
<h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
||
<nav class="tsd-navigation primary">
|
||
<details class="tsd-index-accordion" open><summary class="tsd-accordion-summary">
|
||
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
|
||
<div class="tsd-accordion-details">
|
||
<ul>
|
||
<li class="current"><a href="../modules.html">@sasjs/adapter</a>
|
||
<ul>
|
||
<li class="tsd-kind-module"><a href="../modules/SAS9ApiClient.html">SAS9<wbr/>Api<wbr/>Client</a></li>
|
||
<li class="tsd-kind-module"><a href="../modules/SASViyaApiClient.html">SASViya<wbr/>Api<wbr/>Client</a></li>
|
||
<li class="current selected tsd-kind-module"><a href="../modules/SASjs.html">SASjs</a></li>
|
||
<li class="tsd-kind-module"><a href="../modules/SASjsApiClient.html">SASjs<wbr/>Api<wbr/>Client</a></li>
|
||
<li class="tsd-kind-module"><a href="../modules/types.html">types</a></li></ul></li></ul></div></details></nav>
|
||
<nav class="tsd-navigation secondary menu-sticky">
|
||
<ul>
|
||
<li class="current tsd-kind-class tsd-parent-kind-module"><a href="SASjs.SASjs.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-128-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-128-text"></path></svg><span>SASjs</span></a>
|
||
<ul>
|
||
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="SASjs.SASjs.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-512-path"></use><use href="#icon-512-text"></use></svg>constructor</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#Tables" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>Tables</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#checkSession" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>check<wbr/>Session</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#clearSasRequests" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>clear<wbr/>Sas<wbr/>Requests</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#createComputeContext" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>create<wbr/>Compute<wbr/>Context</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#createFile" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>create<wbr/>File</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#createFolder" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>create<wbr/>Folder</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#createJobDefinition" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>create<wbr/>Job<wbr/>Definition</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#createLauncherContext" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>create<wbr/>Launcher<wbr/>Context</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#createSession" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>create<wbr/>Session</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#deleteClient" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>delete<wbr/>Client</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#deleteComputeContext" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>delete<wbr/>Compute<wbr/>Context</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#deleteFolder" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>delete<wbr/>Folder</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#deployServicePack" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>deploy<wbr/>Service<wbr/>Pack</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#disableVerboseMode" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>disable<wbr/>Verbose<wbr/>Mode</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#editComputeContext" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>edit<wbr/>Compute<wbr/>Context</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#enableVerboseMode" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>enable<wbr/>Verbose<wbr/>Mode</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#executeJob" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>execute<wbr/>Job</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#executeScript" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>execute<wbr/>Script</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#fetchLogFileContent" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>fetch<wbr/>Log<wbr/>File<wbr/>Content</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#getAccessToken" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Access<wbr/>Token</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#getAuthCode" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Auth<wbr/>Code</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#getComputeContextById" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Compute<wbr/>Context<wbr/>By<wbr/>Id</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#getComputeContextByName" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Compute<wbr/>Context<wbr/>By<wbr/>Name</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#getComputeContexts" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Compute<wbr/>Contexts</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#getCsrfToken" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Csrf<wbr/>Token</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#getDefaultComputeContexts" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Default<wbr/>Compute<wbr/>Contexts</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#getExecutableContexts" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Executable<wbr/>Contexts</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#getFileContent" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>File<wbr/>Content</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#getFolder" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Folder</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#getLauncherContexts" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Launcher<wbr/>Contexts</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#getSasRequests" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Sas<wbr/>Requests</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#getSasjsConfig" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Sasjs<wbr/>Config</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#getUserName" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>User<wbr/>Name</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#listFolder" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>list<wbr/>Folder</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#logIn" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>log<wbr/>In</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#logOut" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>log<wbr/>Out</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#moveFolder" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>move<wbr/>Folder</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#refreshTokens" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>refresh<wbr/>Tokens</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#request" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>request</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#setDebugState" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>set<wbr/>Debug<wbr/>State</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#setSASjsConfig" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>setSASjs<wbr/>Config</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#setVerboseMode" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>set<wbr/>Verbose<wbr/>Mode</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#startComputeJob" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>start<wbr/>Compute<wbr/>Job</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#updateFileContent" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>update<wbr/>File<wbr/>Content</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SASjs.SASjs.html#uploadFile" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>upload<wbr/>File</a></li></ul></li></ul></nav></div></div>
|
||
<div class="container tsd-generator">
|
||
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
|
||
<div class="overlay"></div><script src="../assets/main.js"></script></body></html> |