xport-js
Version:
Node.js library to read SAS XPORT v5/v6 data transport files (*.xpt).
34 lines (29 loc) • 11.8 kB
HTML
<html class="default" lang="en" data-base="."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>xport-js</title><meta name="description" content="Documentation for xport-js"/><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 defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><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"><use href="assets/icons.svg#icon-search"></use></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">xport-js</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"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>xport-js</h1></div><div class="tsd-panel tsd-typography"><a id="xport-js" class="tsd-anchor"></a><h1 class="tsd-anchor-link">xport-js<a href="#xport-js" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><p>Library to read in v5/v6 <a href="http://support.sas.com/techsup/technote/ts140.pdf">XPORT files</a> using Node.js .</p>
<a id="installation" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Installation<a href="#installation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><p>To add xport-js to your project, run</p>
<pre><code><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-0">install</span><span class="hl-1"> </span><span class="hl-0">xport</span><span class="hl-1">-</span><span class="hl-0">js</span>
</code><button>Copy</button></pre>
<a id="usage-and-documentation" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Usage and Documentation<a href="#usage-and-documentation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><p>See the library <a href="https://defineeditor.github.io/xport-js/index.html">documentation</a> for details on methods and options available.</p>
<pre><code><span class="hl-2">import</span><span class="hl-1"> </span><span class="hl-0">Library</span><span class="hl-1"> </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">'xport-js'</span><span class="hl-1">;</span><br/><span class="hl-4">// Create a library instance</span><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">lib</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-7">Library</span><span class="hl-1">(</span><span class="hl-3">'/path/to/ds.xpt'</span><span class="hl-1">);</span><br/><span class="hl-4">// Get variable metadata</span><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">metadata</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">lib</span><span class="hl-1">.</span><span class="hl-7">getMetadata</span><span class="hl-1">();</span><br/><span class="hl-4">// Get dataset records as objects</span><br/><span class="hl-5">let</span><span class="hl-1"> </span><span class="hl-0">records</span><span class="hl-1"> = [];</span><br/><span class="hl-2">for</span><span class="hl-1"> </span><span class="hl-2">await</span><span class="hl-1"> (</span><span class="hl-5">let</span><span class="hl-1"> </span><span class="hl-0">obs</span><span class="hl-1"> </span><span class="hl-5">of</span><span class="hl-1"> </span><span class="hl-0">lib</span><span class="hl-1">.</span><span class="hl-7">read</span><span class="hl-1">({ </span><span class="hl-0">rowFormat:</span><span class="hl-1"> </span><span class="hl-3">'object'</span><span class="hl-1"> })) {</span><br/><span class="hl-1"> </span><span class="hl-0">records</span><span class="hl-1">.</span><span class="hl-7">push</span><span class="hl-1">(</span><span class="hl-0">obs</span><span class="hl-1">);</span><br/><span class="hl-1">}</span><br/><span class="hl-4">// Output contents of XPT file to CSV file(s)</span><br/><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">lib</span><span class="hl-1">.</span><span class="hl-7">toCsv</span><span class="hl-1">(</span><span class="hl-3">'/outDir/'</span><span class="hl-1">)</span>
</code><button>Copy</button></pre>
<a id="libraryread-method" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Library.read method<a href="#libraryread-method" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>This method return AsyncIterable which can be used in <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of">for await ... of</a> statement.</p>
<pre><code><span class="hl-0">lib</span><span class="hl-1">.</span><span class="hl-7">read</span><span class="hl-1">(</span><span class="hl-0">options</span><span class="hl-1">);</span>
</code><button>Copy</button></pre>
<ul>
<li><strong>dsNames</strong> List of dataset names to read, by default all datasets are read.</li>
<li><strong>rowFormat</strong> [default=array] Output observation format.
<em>array</em>: [value1, value2, value3, ...]
<em>object</em>: { var1: value1, var: value2, var3: value3, ... }</li>
<li><strong>keep</strong> [default=[]] Array of variables to keep in the result (case-insensitive)</li>
<li><strong>skipHeader</strong> [default=false] Flag to control whether the first record contains variable names.</li>
<li><strong>encoding</strong> [default=binary] String encoding, default is latin1 (binary). See the list of <a href="https://nodejs.org/api/buffer.html#buffer_buffers_and_character_encodings">encodings</a> supported by Node.js.</li>
</ul>
<a id="librarytocsv-method" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Library.toCsv method<a href="#librarytocsv-method" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Creates CSV file(s) in the outDir.</p>
<pre><code><span class="hl-0">lib</span><span class="hl-1">.</span><span class="hl-7">read</span><span class="hl-1">(</span><span class="hl-0">outDir</span><span class="hl-1">, </span><span class="hl-0">options</span><span class="hl-1">);</span>
</code><button>Copy</button></pre>
<p>See read method options description for details.</p>
<a id="authors" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Authors<a href="#authors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><ul>
<li><a href="https://www.linkedin.com/in/dmitry-kolosov-91751413/"><strong>Dmitry Kolosov</strong></a></li>
<li><a href="https://www.linkedin.com/in/sergey-krivtsov-677419b4/"><strong>Sergei Krivtcov</strong></a></li>
</ul>
<a id="license" class="tsd-anchor"></a><h1 class="tsd-anchor-link">License<a href="#license" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><p>This project is licensed under the MIT License - see the <a href="media/LICENSE">LICENSE</a> file for details.</p>
</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><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><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><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>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#xport-js"><span>xport-<wbr/>js</span></a><a href="#installation"><span>Installation</span></a><a href="#usage-and-documentation"><span>Usage and <wbr/>Documentation</span></a><ul><li><a href="#libraryread-method"><span>Library.read method</span></a></li><li><a href="#librarytocsv-method"><span>Library.to<wbr/>Csv method</span></a></li></ul><a href="#authors"><span>Authors</span></a><a href="#license"><span>License</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html">xport-js</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>