ts-simple-ast

<!doctype html> <html> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <title>TsSimpleAst</title> <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-alpha.6/css/bootstrap.min.css" integrity="sha384-rwoIResjU2yc3z8GV/NPeZWAv56rSmLldC3R/AZzGRnGxQQKnKkoFVhFQhNUwEyJ" crossorigin="anonymous"> <link rel="stylesheet" href="/assets/css/style.css?v=71a391c40e7283d83416a246f2c61c5fcb76068a">  </head> <body> <div class="main"> <header class="container"> <div class="row"> <h1 onclick="document.location.href = '/'" class="headerLink">TsSimpleAst</h1>  </div> </header> <div class="container"> <div class="row"> <div class="col-md-3"> <button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation"> <span class="navbar-toggler-icon"></span> </button> <nav class="sidebar-nav" id="navbarSupportedContent"> <ul class="navbar-nav navbar-default"> <li class="nav-item"> <a class="nav-link" href="/">Overview</a> </li> <li class="nav-item"> <a class="nav-link" href="/setup">Setup</a> </li> <li class="nav-item"> <a class="nav-link" href="/navigation">Navigation</a> </li> <li class="nav-item"> <a class="nav-link" href="/manipulation">Manipulation</a> </li> <li class=""> <a class="nav-link" href="/details/index">Details</a> <ul> <li class="active"><a href="/details/source-files">Source Files</a></li> <li class=""><a href="/details/classes">Classes</a></li> <li class=""><a href="/details/enums">Enums</a></li> <li class=""><a href="/details/functions">Functions</a></li> <li class=""><a href="/details/interfaces">Interfaces</a></li> <li class=""><a href="/details/namespaces">Namespaces</a></li> <li class=""><a href="/details/type-aliases">Type Aliases</a></li> <li class=""><a href="/details/variables">Variables</a></li> <li>--</li> <li class=""><a href="/details/types">Types</a></li> <li class=""><a href="/details/expressions">Expressions</a></li> <li>--</li> <li class=""><a href="/details/ambient">Ambient</a></li> <li class=""><a href="/details/async">Async</a></li> <li class=""><a href="/details/decorators">Decorators</a></li> <li class=""><a href="/details/exports">Exports</a></li> <li class=""><a href="/details/generators">Generators</a></li> <li class=""><a href="/details/documentation">JS Docs</a></li> <li class=""><a href="/details/modifiers">Modifiers</a></li> </ul> </li> <li class="nav-item"> <a class="nav-link" href="http://github.com/dsherret/ts-simple-ast">View on GitHub</a> </li> </ul> </nav> </div> <section class="container-fluid col-md-9"> <h2 id="source-files">Source Files</h2> <p>Source files are the root nodes of the AST.</p> <h3 id="get-file-path">Get file path</h3> <p>Use:</p> <div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="nx">sourceFile</span><span class="p">.</span><span class="nx">getFilePath</span><span class="p">();</span> <span class="c1">// returns: string</span> </code></pre> </div> <h3 id="check-if-declaration-file">Check if declaration file</h3> <p>Use:</p> <div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="nx">sourceFile</span><span class="p">.</span><span class="nx">isDeclarationFile</span><span class="p">();</span> <span class="c1">// returns: boolean</span> </code></pre> </div> <h3 id="get-referenced-files">Get referenced files</h3> <p>This returns any files that are referenced via <code class="highlighter-rouge">/// <reference path="..." /></code> statements:</p> <div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="kd">const</span> <span class="nx">referencedFiles</span> <span class="o">=</span> <span class="nx">sourceFile</span><span class="p">.</span><span class="nx">getReferencedFiles</span><span class="p">();</span> </code></pre> </div> <h3 id="save-to-file-system">Save to file system</h3> <p>You can save a source file to the file system using one of the following commands:</p> <div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="nx">sourceFile</span><span class="p">.</span><span class="nx">save</span><span class="p">(</span><span class="nx">err</span> <span class="o">=></span> <span class="p">{});</span> <span class="c1">// callback is optional</span> <span class="nx">sourceFile</span><span class="p">.</span><span class="nx">saveSync</span><span class="p">();</span> </code></pre> </div> <h3 id="copy">Copy</h3> <p>You can copy a source file to a new file by specifying a new relative or absolute path:</p> <div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="kd">const</span> <span class="nx">newSourceFile</span> <span class="o">=</span> <span class="nx">sourceFile</span><span class="p">.</span><span class="nx">copy</span><span class="p">(</span><span class="s2">"newFileName.ts"</span><span class="p">);</span> </code></pre> </div> <p>Note that the file won’t be written to the file system unless you save it.</p> <h3 id="move">Move</h3> <p>TODO: Not yet supported.</p> <h3 id="remove">Remove</h3> <p>TODO: Not yet supported.</p> <h3 id="get-default-export-symbol">Get default export symbol</h3> <p>If it exists, the default export symbol can be retrieved:</p> <div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="kd">const</span> <span class="nx">defaultExportSymbol</span> <span class="o">=</span> <span class="nx">sourceFile</span><span class="p">.</span><span class="nx">getDefaultExportSymbol</span><span class="p">();</span> <span class="c1">// returns: Symbol | undefined</span> </code></pre> </div> <h3 id="remove-default-export">Remove default export</h3> <p>Use:</p> <div class="language-typescript highlighter-rouge"><pre class="highlight"><code><span class="nx">sourceFile</span><span class="p">.</span><span class="nx">removeDefaultExport</span><span class="p">();</span> </code></pre> </div> <p>Note: This is safe to call even when there is no default export.</p> </section> </div> </div> <footer> </footer> </div> <script src="https://code.jquery.com/jquery-3.1.1.slim.min.js" integrity="sha384-A7FZj7v+d/sdmMqp/nOQwliLvUsJfDHW+k9Omg/a/EheAdgtzNs3hpfag6Ed950n" crossorigin="anonymous"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/tether/1.4.0/js/tether.min.js" integrity="sha384-DztdAPBWPRXSA/3eYEEUWrWCy7G5KFbe8fFjk5JAIxUYHKkDx6Qin1DkWx51bBrb" crossorigin="anonymous"></script> <script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-alpha.6/js/bootstrap.min.js" integrity="sha384-vBWWzlZJ8ea9aCX4pEW3rVHjgjt7zpkNpZk+02D9phzyeVkE+jo0ieGizqPLForn" crossorigin="anonymous"></script>  </body> </html>