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>ts-simple-ast - Export</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=502728dc7b09041e36b06c50f79a13adbfb6f1b2">  </head> <body> <div class="main"> <header class="container"> <div class="row"> <h1 onclick="document.location.href = '/'" class="headerLink">ts-simple-ast</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"> </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="nav-item"> <a class="nav-link" href="/emitting">Emitting</a> </li> <li class=""> <a class="nav-link" href="/details/index">Details</a> <ul> <li class=""><a href="/details/source-files">Source Files</a></li> <li class=""><a href="/details/classes">Classes</a></li> <li class=""><a href="/details/decorators">Decorators</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/imports">Imports</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/parameters">Parameters</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/signatures">Signatures</a></li> <li>--</li> <li class=""><a href="/details/expressions">Expressions</a></li> <li class=""><a href="/details/object-literal-expressions">Object Literal Expressions</a></li> <li class=""><a href="/details/identifiers">Identifiers</a></li> <li class=""><a href="/details/ambient">Ambient</a></li> <li class=""><a href="/details/async">Async</a></li> <li class="active"><a href="/details/exports">Exports</a></li> <li class=""><a href="/details/generators">Generators</a></li> <li class=""><a href="/details/initializers">Initializers</a></li> <li class=""><a href="/details/documentation">JS Docs</a></li> <li class=""><a href="/details/literals">Literals</a></li> <li class=""><a href="/details/modifiers">Modifiers</a></li> </ul> </li> <li class="nav-item"> <a class="nav-link" href="/utilities">Utilities</a> </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="export">Export</h2> Certain nodes in TypeScript can be <a href="https://www.typescriptlang.org/docs/handbook/modules.html">exported</a>. <h3 id="is-export">Is export</h3> Use <code class="highlighter-rouge">isExported()</code>, <code class="highlighter-rouge">isNamedExport()</code>, or <code class="highlighter-rouge">isDefaultExport()</code> methods: <div class="language-typescript highlighter-rouge"><pre class="highlight"><code>functionDeclaration.isExported(); // returns: boolean functionDeclaration.isNamedExport(); // returns: boolean functionDeclaration.isDefaultExport(); // returns: boolean </code></pre> </div> <h3 id="export-and-default-keyword"><code class="highlighter-rouge">export</code> and <code class="highlighter-rouge">default</code> keyword</h3> Use the <code class="highlighter-rouge">has</code> methods to check for the <code class="highlighter-rouge">export</code> and <code class="highlighter-rouge">default</code> keywords: <div class="language-typescript highlighter-rouge"><pre class="highlight"><code>functionDeclaration.hasExportKeyword(); // returns: boolean functionDeclaration.hasDefaultKeyword(); // returns: boolean </code></pre> </div> And use the <code class="highlighter-rouge">get</code> methods to get the keywords: <div class="language-typescript highlighter-rouge"><pre class="highlight"><code>functionDeclaration.getExportKeyword(); functionDeclaration.getDefaultKeyword(); </code></pre> </div> <h3 id="setting-as-default-export">Setting as default export</h3> Use <code class="highlighter-rouge">setIsDefaultExport</code> to set a node as being a default export or not: <div class="language-typescript highlighter-rouge"><pre class="highlight"><code>functionDeclaration.setIsDefaultExport(true); // be one functionDeclaration.setIsDefaultExport(false); // don't be one </code></pre> </div> Note: This will throw an exception if the node’s parent is not a source file. <h3 id="setting-as-export">Setting as export</h3> Use <code class="highlighter-rouge">setIsExported</code> to set a node as being a named export if the parent is a source file or an export of a namespace if the parent is a namespace: <div class="language-typescript highlighter-rouge"><pre class="highlight"><code>functionDeclaration.setIsExported(true); // be one functionDeclaration.setIsExported(false); // don't be one </code></pre> </div> <h2 id="export-declarations">Export Declarations</h2> Export declarations look like this: <div class="language-typescript highlighter-rouge"><pre class="highlight"><code>export * from "./some-file"; export {MyClass} from "./other-file"; export {MyClass}; </code></pre> </div> Get the export declarations by calling: <div class="language-typescript highlighter-rouge"><pre class="highlight"><code>const exports = sourceFile.getExportDeclarations(); // or to get the first one that matches a condition const exportDeclaration = sourceFile.getExportDeclaration(d => d.hasNamedExports()); // tell if it has named exports exportDeclaration.hasNamedExports(); // or if it's a namespace export exportDeclaration.isNamespaceExport(); // get/set the module specifier exportDeclaration.getModuleSpecifier(); // returns: string | undefined exportDeclaration.setModuleSpecifier("./new-file"); exportDeclaration.hasModuleSpecifier(); // returns: boolean </code></pre> </div> <h3 id="addinsert">Add/Insert</h3> Add or insert use <code class="highlighter-rouge">insertExportDeclaration</code>, <code class="highlighter-rouge">insertExportDeclarations</code>, <code class="highlighter-rouge">addExportDeclaration</code>, or <code class="highlighter-rouge">addExportDeclarations</code>: <div class="language-typescript highlighter-rouge"><pre class="highlight"><code>const exportDeclaration = sourceFile.addExportDeclaration({ defaultImport: "MyClass", moduleSpecifier: "./file" }); </code></pre> </div> <h3 id="remove">Remove</h3> Call <code class="highlighter-rouge">.remove()</code>: <div class="language-typescript highlighter-rouge"><pre class="highlight"><code>exportDeclaration.remove(); </code></pre> </div> <h3 id="to-namespace-export">To Namespace Export</h3> Given an export declaration with named exports: <div class="language-typescript highlighter-rouge"><pre class="highlight"><code>export {Export1, Export2, Export3} from "./other-file"; </code></pre> </div> Calling <code class="highlighter-rouge">exportDeclaration.toNamespaceExport();</code> will change the code to the following: <div class="language-typescript highlighter-rouge"><pre class="highlight"><code>export * from "./other-file"; </code></pre> </div> <h3 id="named-exports">Named Exports</h3> Get the named exports from an export declaration: <div class="language-typescript highlighter-rouge"><pre class="highlight"><code>const namedExports = exportDeclaration.getNamedExports(); </code></pre> </div> Adding or inserting named exports can be done via the <code class="highlighter-rouge">addNamedExport</code>, <code class="highlighter-rouge">addNamedExports</code>, <code class="highlighter-rouge">insertNamedExport</code>, or <code class="highlighter-rouge">insertNamedExports</code> methods. <div class="language-typescript highlighter-rouge"><pre class="highlight"><code>const namedExport = exportDeclaration.addNamedExport({ name: "MyClass", alias: "MyAliasName" // alias is optional }); </code></pre> </div> Removing one named export: <div class="language-typescript highlighter-rouge"><pre class="highlight"><code>namedExport.remove(); </code></pre> </div> <h4 id="export-specifier">Export specifier</h4> Export specifiers are the individual named exports. <h5 id="name">Name</h5> <div class="language-typescript highlighter-rouge"><pre class="highlight"><code>namedExport.getNameNode(); // returns: Identifier namedExport.setName("NewName"); namedExport.renameName("NewName"); </code></pre> </div> <h5 id="alias">Alias</h5> <div class="language-typescript highlighter-rouge"><pre class="highlight"><code>namedExport.getAliasIdentifier(); // returns: Identifier | undefined namedExport.setAlias("NewAliasName"); </code></pre> </div> Note: Setting the alias will rename any uses of the alias or identifier to the new value. <h5 id="parent-export-declaration">Parent export declaration</h5> <div class="language-typescript highlighter-rouge"><pre class="highlight"><code>namedExport.getExportDeclaration(); // returns: ExportDeclaration </code></pre> </div> <h2 id="export-assignments">Export Assignments</h2> Export assignments look like the following: <div class="language-typescript highlighter-rouge"><pre class="highlight"><code>export = 5; export default name; </code></pre> </div> Get the export assignments by calling: <div class="language-typescript highlighter-rouge"><pre class="highlight"><code>const exportAssignments = sourceFile.getExportAssignments(); // or to get the first one that matches a condition const exportAssignment = sourceFile.getExportAssignment(d => d.isExportEquals()); // get if it's `export =` or `export default` const isExportEquals = exportAssignment.isExportEquals(); // get the expression const expression = exportAssignment.getExpression(); </code></pre> </div> <h3 id="addinsert-1">Add/Insert</h3> Add or insert use <code class="highlighter-rouge">insertExportAssignment</code>, <code class="highlighter-rouge">insertExportAssignments</code>, <code class="highlighter-rouge">addExportAssignment</code>, or <code class="highlighter-rouge">addExportAssignments</code>: <div class="language-typescript highlighter-rouge"><pre class="highlight"><code>const exportAssignment = sourceFile.addExportAssignment({ isExportEquals: true, // defaults to true expression: "5" }); </code></pre> </div> <h3 id="remove-1">Remove</h3> Call <code class="highlighter-rouge">.remove()</code>: <div class="language-typescript highlighter-rouge"><pre class="highlight"><code>exportAssignment.remove(); </code></pre> </div> </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>