mirror of
https://github.com/sasjs/adapter.git
synced 2025-12-10 17:04:36 +00:00
250 lines
16 KiB
HTML
250 lines
16 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>SASjsConfig | sasjs</title>
|
|
<meta name="description" content="">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|
</head>
|
|
<body>
|
|
<header>
|
|
<div class="tsd-page-toolbar">
|
|
<div class="container">
|
|
<div class="table-wrap">
|
|
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
|
|
<div class="field">
|
|
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
<input id="tsd-search-field" type="text" />
|
|
</div>
|
|
<ul class="results">
|
|
<li class="state loading">Preparing search index...</li>
|
|
<li class="state failure">The search index is not available</li>
|
|
</ul>
|
|
<ul class="results-priority" style="display:none">
|
|
</ul>
|
|
<a href="../index.html" class="title">sasjs</a>
|
|
 <a href="https://github.com/macropeople/sasjs" class="title">SASjs on Github</a>
|
|
 <a href="https://sasjs.io" class="title">SASjs.io</a>
|
|
 <a href="https://github.com/macropeople/sasjs-cli" class="title">SASjs CLI</a>
|
|
 <a href="https://github.com/macropeople/react-seed-app" class="title">React Seed App</a>
|
|
</div>
|
|
<div class="table-cell" id="tsd-widgets">
|
|
<div id="tsd-filter">
|
|
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
<div class="tsd-filter-group">
|
|
<div class="tsd-select" id="tsd-filter-visibility">
|
|
<span class="tsd-select-label">All</span>
|
|
<ul class="tsd-select-list">
|
|
<li data-value="public">Public</li>
|
|
<li data-value="protected">Public/Protected</li>
|
|
<li data-value="private" class="selected">All</li>
|
|
</ul>
|
|
</div>
|
|
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
</div>
|
|
</div>
|
|
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="tsd-page-title">
|
|
<div class="container">
|
|
<ul class="tsd-breadcrumb">
|
|
<li>
|
|
<a href="../modules/sasjsconfig.html">SASjsConfig</a>
|
|
</li>
|
|
<li>
|
|
<a href="sasjsconfig.sasjsconfig-1.html">SASjsConfig</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container container-main">
|
|
<div class="row">
|
|
<div class="col-3 col-menu menu-sticky-wrap menu-highlight">
|
|
<nav class="tsd-navigation outline primary">
|
|
<a style="margin-left:0em" href="../globals.html">Globals</a>
|
|
<ul style="display:none">
|
|
{"SAS Adapter":{"SASjs":"modules/sasjs","SASjsConfig":"classes/sasjsconfig.sasjsconfig-1","ServerType":"enums/servertype.servertype-1","SASjsRequest":"interfaces/sasjsrequest.sasjsrequest-1","SASjsWaitingRequest":"interfaces/sasjswaitingrequest.sasjswaitingrequest-1"},"SAS Viya API Client":"classes/sasviyaapiclient.sasviyaapiclient-1","SAS 9 API Client":"classes/sas9apiclient.sas9apiclient-1"}
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
<div class="col-7 offset-3 col-content">
|
|
<h1>Class SASjsConfig</h1>
|
|
<section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography tsd-comment-shorttext">
|
|
<div class="lead">
|
|
<p>Specifies the configuration for the SASjs instance.</p>
|
|
</div></div></section>
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h3>Hierarchy</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="target">SASjsConfig</span>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-index-group">
|
|
<section class="tsd-panel tsd-index-panel">
|
|
<div class="tsd-index-content">
|
|
<section class="tsd-index-section ">
|
|
<h3>Properties</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="sasjsconfig.sasjsconfig-1.html#apploc" class="tsd-kind-icon">appLoc</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="sasjsconfig.sasjsconfig-1.html#contextname" class="tsd-kind-icon">contextName</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="sasjsconfig.sasjsconfig-1.html#debug" class="tsd-kind-icon">debug</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="sasjsconfig.sasjsconfig-1.html#pathsas9" class="tsd-kind-icon">pathSAS9</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="sasjsconfig.sasjsconfig-1.html#pathsasviya" class="tsd-kind-icon">pathSASViya</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="sasjsconfig.sasjsconfig-1.html#servertype" class="tsd-kind-icon">serverType</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="sasjsconfig.sasjsconfig-1.html#serverurl" class="tsd-kind-icon">serverUrl</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Properties</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
<a name="apploc" class="tsd-anchor"></a>
|
|
<h3>app<wbr>Loc</h3>
|
|
<div class="tsd-signature tsd-kind-icon">app<wbr>Loc<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in types/SASjsConfig.ts:20</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
|
|
<div class="lead">
|
|
<p>The appLoc is the parent folder under which the SAS services (STPs or Job
|
|
Execution Services) are stored.</p>
|
|
</div></div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
<a name="contextname" class="tsd-anchor"></a>
|
|
<h3>context<wbr>Name</h3>
|
|
<div class="tsd-signature tsd-kind-icon">context<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in types/SASjsConfig.ts:29</li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
<a name="debug" class="tsd-anchor"></a>
|
|
<h3>debug</h3>
|
|
<div class="tsd-signature tsd-kind-icon">debug<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in types/SASjsConfig.ts:28</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
|
|
<div class="lead">
|
|
<p>Set to <code>true</code> to enable additional debugging.</p>
|
|
</div></div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
<a name="pathsas9" class="tsd-anchor"></a>
|
|
<h3>pathSAS9</h3>
|
|
<div class="tsd-signature tsd-kind-icon">pathSAS9<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in types/SASjsConfig.ts:14</li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
<a name="pathsasviya" class="tsd-anchor"></a>
|
|
<h3>pathSASViya</h3>
|
|
<div class="tsd-signature tsd-kind-icon">pathSASViya<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in types/SASjsConfig.ts:15</li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
<a name="servertype" class="tsd-anchor"></a>
|
|
<h3>server<wbr>Type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">server<wbr>Type<span class="tsd-signature-symbol">:</span> <a href="../enums/servertype.servertype-1.html" class="tsd-signature-type">ServerType</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> = null</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in types/SASjsConfig.ts:24</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
|
|
<div class="lead">
|
|
<p>Can be SAS9 or SASVIYA</p>
|
|
</div></div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
<a name="serverurl" class="tsd-anchor"></a>
|
|
<h3>server<wbr>Url</h3>
|
|
<div class="tsd-signature tsd-kind-icon">server<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in types/SASjsConfig.ts:13</li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
|
|
<div class="lead">
|
|
<p>The location (including http protocol and port) of the SAS Server.
|
|
Can be omitted, eg if serving directly from the SAS Web Server or being
|
|
streamed.</p>
|
|
</div></div>
|
|
</section>
|
|
</section>
|
|
<!--{"options":"/Users/allan/git/sasjs","tsconfig":"/Users/allan/git/sasjs","inputFiles":["/Users/allan/git/sasjs/src/SAS9ApiClient.ts","/Users/allan/git/sasjs/src/SASViyaApiClient.ts","/Users/allan/git/sasjs/src/SASjs.ts","/Users/allan/git/sasjs/src/index.ts","/Users/allan/git/sasjs/src/types/Context.ts","/Users/allan/git/sasjs/src/types/CsrfToken.ts","/Users/allan/git/sasjs/src/types/Folder.ts","/Users/allan/git/sasjs/src/types/Job.ts","/Users/allan/git/sasjs/src/types/JobResult.ts","/Users/allan/git/sasjs/src/types/Link.ts","/Users/allan/git/sasjs/src/types/SASjsConfig.ts","/Users/allan/git/sasjs/src/types/SASjsRequest.ts","/Users/allan/git/sasjs/src/types/SASjsWaitingRequest.ts","/Users/allan/git/sasjs/src/types/ServerType.ts","/Users/allan/git/sasjs/src/types/Session.ts","/Users/allan/git/sasjs/src/types/index.ts","/Users/allan/git/sasjs/src/utils/asyncForEach.ts","/Users/allan/git/sasjs/src/utils/compareTimestamps.ts","/Users/allan/git/sasjs/src/utils/convertToCsv.ts","/Users/allan/git/sasjs/src/utils/index.ts","/Users/allan/git/sasjs/src/utils/isAuthorizeFormRequired.ts","/Users/allan/git/sasjs/src/utils/isLoginRequired.ts","/Users/allan/git/sasjs/src/utils/isLoginSuccess.ts","/Users/allan/git/sasjs/src/utils/makeRequest.ts","/Users/allan/git/sasjs/src/utils/needsRetry.ts","/Users/allan/git/sasjs/src/utils/parseAndSubmitAuthorizeForm.ts","/Users/allan/git/sasjs/src/utils/parseGeneratedCode.ts","/Users/allan/git/sasjs/src/utils/parseSasViyaLog.ts","/Users/allan/git/sasjs/src/utils/parseSourceCode.ts","/Users/allan/git/sasjs/src/utils/serialize.ts","/Users/allan/git/sasjs/src/utils/splitChunks.ts"],"mode":1,"includeDeclarations":true,"entryPoint":"","exclude":["**/*+(index|.spec|.e2e).ts"],"externalPattern":[],"excludeExternals":true,"excludeNotExported":true,"excludeNotDocumented":false,"excludePrivate":true,"excludeProtected":false,"ignoreCompilerErrors":true,"disableSources":false,"includes":"","media":"","out":"docs","json":"","theme":"./node_modules/typedoc-neo-theme/bin/default","name":"","includeVersion":false,"excludeTags":[],"readme":"","defaultCategory":"Other","categoryOrder":[],"categorizeByGroup":true,"gitRevision":"","gitRemote":"origin","gaID":"","gaSite":"auto","hideGenerator":false,"toc":[],"disableOutputCheck":true,"help":false,"version":false,"plugin":[],"logger":"console","listInvalidSymbolLinks":false,"links":[{"label":"SASjs on Github","url":"https://github.com/macropeople/sasjs"},{"label":"SASjs.io","url":"https://sasjs.io"},{"label":"SASjs CLI","url":"https://github.com/macropeople/sasjs-cli"},{"label":"React Seed App","url":"https://github.com/macropeople/react-seed-app"}],"outline":[{"SAS Adapter":{"SASjs":"modules/sasjs","SASjsConfig":"classes/sasjsconfig.sasjsconfig-1","ServerType":"enums/servertype.servertype-1","SASjsRequest":"interfaces/sasjsrequest.sasjsrequest-1","SASjsWaitingRequest":"interfaces/sasjswaitingrequest.sasjswaitingrequest-1"},"SAS Viya API Client":"classes/sasviyaapiclient.sasviyaapiclient-1","SAS 9 API Client":"classes/sas9apiclient.sas9apiclient-1"}],"disableAutoModuleName":"false"}-->
|
|
</div>
|
|
<div class="col-2 col-menu secondary-menu">
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="current tsd-kind-class tsd-parent-kind-module root">
|
|
<a href="sasjsconfig.sasjsconfig-1.html" class="tsd-kind-icon">SASjs<wbr>Config</a>
|
|
<ul>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="sasjsconfig.sasjsconfig-1.html#apploc" class="tsd-kind-icon">app<wbr>Loc</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="sasjsconfig.sasjsconfig-1.html#contextname" class="tsd-kind-icon">context<wbr>Name</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="sasjsconfig.sasjsconfig-1.html#debug" class="tsd-kind-icon">debug</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="sasjsconfig.sasjsconfig-1.html#pathsas9" class="tsd-kind-icon">pathSAS9</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="sasjsconfig.sasjsconfig-1.html#pathsasviya" class="tsd-kind-icon">pathSASViya</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="sasjsconfig.sasjsconfig-1.html#servertype" class="tsd-kind-icon">server<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="sasjsconfig.sasjsconfig-1.html#serverurl" class="tsd-kind-icon">server<wbr>Url</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="after-current">
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<footer class="with-border-bottom">
|
|
</footer>
|
|
<div class="container tsd-generator">
|
|
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
</div>
|
|
<div class="overlay"></div>
|
|
<script src="../assets/js/main.js"></script>
|
|
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
|
|
</body>
|
|
</html> |