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

deploy: 7e23b5db9d

Browse Source
This commit is contained in:
allanbowe
2025-06-09 18:24:34 +00:00
parent 38c817cad7
commit c4d62a3779
54 changed files with 302 additions and 302 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
classes/types.SASjsConfig.html
View File

@@ -25,7 +25,7 @@ connect to SAS.</p>
<ul class="tsd-hierarchy">
<li><span class="target">SASjsConfig</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/55af8c3/src/types/SASjsConfig.ts#L9">types/SASjsConfig.ts:9</a></li></ul></aside>
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/7e23b5d/src/types/SASjsConfig.ts#L9">types/SASjsConfig.ts:9</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">
@@ -73,7 +73,7 @@ When using appLoc, the paths provided in the <code>request</code> function shoul
<em>without</em> a leading slash (/).</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/55af8c3/src/types/SASjsConfig.ts#L40">types/SASjsConfig.ts:40</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/7e23b5d/src/types/SASjsConfig.ts#L40">types/SASjsConfig.ts:40</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="contextName" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>context<wbr/>Name</span><a href="#contextName" 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>
<div class="tsd-signature">context<wbr/>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;&#39;</span></div>
@@ -81,14 +81,14 @@ When using appLoc, the paths provided in the <code>request</code> function shoul
Example value: &#39;SAS Job Execution compute context&#39;</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/55af8c3/src/types/SASjsConfig.ts#L57">types/SASjsConfig.ts:57</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/7e23b5d/src/types/SASjsConfig.ts#L57">types/SASjsConfig.ts:57</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="debug" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>debug</span><a href="#debug" 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>
<div class="tsd-signature">debug<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div>
<div class="tsd-comment tsd-typography"><p>Set to <code>true</code> to enable additional debugging.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/55af8c3/src/types/SASjsConfig.ts#L48">types/SASjsConfig.ts:48</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/7e23b5d/src/types/SASjsConfig.ts#L48">types/SASjsConfig.ts:48</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="httpsAgentOptions" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>https<wbr/>Agent<wbr/>Options</span><a href="#httpsAgentOptions" 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>
<div class="tsd-signature">https<wbr/>Agent<wbr/>Options<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AgentOptions</span></div>
@@ -97,14 +97,14 @@ By providing <code>key</code>, <code>cert</code>, <code>ca</code> to connect wit
Other options can be set <code>rejectUnauthorized</code> and <code>requestCert</code></p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/55af8c3/src/types/SASjsConfig.ts#L72">types/SASjsConfig.ts:72</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/7e23b5d/src/types/SASjsConfig.ts#L72">types/SASjsConfig.ts:72</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="loginMechanism" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>login<wbr/>Mechanism</span><a href="#loginMechanism" 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>
<div class="tsd-signature">login<wbr/>Mechanism<span class="tsd-signature-symbol">:</span> <a href="../enums/types.LoginMechanism.html" class="tsd-signature-type" data-tsd-kind="Enumeration">LoginMechanism</a><span class="tsd-signature-symbol"> = LoginMechanism.Default</span></div>
<div class="tsd-comment tsd-typography"><p>Supported login mechanisms are - Redirected and Default</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/55af8c3/src/types/SASjsConfig.ts#L76">types/SASjsConfig.ts:76</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/7e23b5d/src/types/SASjsConfig.ts#L76">types/SASjsConfig.ts:76</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="pathSAS9" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>pathSAS9</span><a href="#pathSAS9" 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>
<div class="tsd-signature">pathSAS9<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;&#39;</span></div>
@@ -112,7 +112,7 @@ Other options can be set <code>rejectUnauthorized</code> and <code>requestCert</
will use &#39;/SASStoredProcess/do&#39; on SAS 9.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/55af8c3/src/types/SASjsConfig.ts#L25">types/SASjsConfig.ts:25</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/7e23b5d/src/types/SASjsConfig.ts#L25">types/SASjsConfig.ts:25</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="pathSASJS" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>pathSASJS</span><a href="#pathSASJS" 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>
<div class="tsd-signature">pathSASJS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;&#39;</span></div>
@@ -120,7 +120,7 @@ will use &#39;/SASStoredProcess/do&#39; on SAS 9.</p>
will use &#39;/SASjsApi/stp/execute&#39; on SAS JS.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/55af8c3/src/types/SASjsConfig.ts#L20">types/SASjsConfig.ts:20</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/7e23b5d/src/types/SASjsConfig.ts#L20">types/SASjsConfig.ts:20</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="pathSASViya" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>pathSASViya</span><a href="#pathSASViya" 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>
<div class="tsd-signature">pathSASViya<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;&#39;</span></div>
@@ -128,7 +128,7 @@ will use &#39;/SASjsApi/stp/execute&#39; on SAS JS.</p>
will use &#39;/SASJobExecution&#39; on SAS Viya.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/55af8c3/src/types/SASjsConfig.ts#L30">types/SASjsConfig.ts:30</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/7e23b5d/src/types/SASjsConfig.ts#L30">types/SASjsConfig.ts:30</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="requestHistoryLimit" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request<wbr/>History<wbr/>Limit</span><a href="#requestHistoryLimit" 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>
<div class="tsd-signature">request<wbr/>History<wbr/>Limit<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 10</span></div>
@@ -136,14 +136,14 @@ will use &#39;/SASJobExecution&#39; on SAS Viya.</p>
may affect browser performance, especially with debug (logs) enabled.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/55af8c3/src/types/SASjsConfig.ts#L81">types/SASjsConfig.ts:81</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/7e23b5d/src/types/SASjsConfig.ts#L81">types/SASjsConfig.ts:81</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="serverType" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>server<wbr/>Type</span><a href="#serverType" 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>
<div class="tsd-signature">server<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ServerType</span><span class="tsd-signature-symbol"> = null</span></div>
<div class="tsd-comment tsd-typography"><p>Can be <code>SAS9</code> or <code>SASVIYA</code>.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/55af8c3/src/types/SASjsConfig.ts#L44">types/SASjsConfig.ts:44</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/7e23b5d/src/types/SASjsConfig.ts#L44">types/SASjsConfig.ts:44</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="serverUrl" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>server<wbr/>Url</span><a href="#serverUrl" 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>
<div class="tsd-signature">server<wbr/>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;&#39;</span></div>
@@ -152,7 +152,7 @@ Can be omitted, eg if serving directly from the SAS Web Server or being
streamed.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/55af8c3/src/types/SASjsConfig.ts#L15">types/SASjsConfig.ts:15</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/7e23b5d/src/types/SASjsConfig.ts#L15">types/SASjsConfig.ts:15</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="useComputeApi" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>use<wbr/>Compute<wbr/>Api</span><a href="#useComputeApi" 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>
<div class="tsd-signature">use<wbr/>Compute<wbr/>Api<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = null</span></div>
@@ -164,14 +164,14 @@ under the identity in the JES context. If <code>useComputeApi</code> is <code>n
triggered using the APIs instead of the Job Execution Web Service broker.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/55af8c3/src/types/SASjsConfig.ts#L66">types/SASjsConfig.ts:66</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/7e23b5d/src/types/SASjsConfig.ts#L66">types/SASjsConfig.ts:66</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="verbose" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>verbose</span><a href="#verbose" 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>
<div class="tsd-signature">verbose<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"> = true</span></div>
<div class="tsd-comment tsd-typography"><p>Set to <code>true</code> to enable verbose mode that will log a summary of every HTTP response.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/55af8c3/src/types/SASjsConfig.ts#L52">types/SASjsConfig.ts:52</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/sasjs/adapter/blob/7e23b5d/src/types/SASjsConfig.ts#L52">types/SASjsConfig.ts:52</a></li></ul></aside></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">